Skip to main content
POST
/
v1
/
project
Create project
curl --request POST \
  --url https://api.braintrust.dev/v1/project \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "org_name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "settings": {
    "comparison_key": "<string>",
    "baseline_experiment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "spanFieldOrder": [
      {
        "object_type": "<string>",
        "column_id": "<string>",
        "position": "<string>",
        "layout": "full"
      }
    ],
    "remote_eval_sources": [
      {
        "url": "<string>",
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "disable_realtime_queries": true,
    "default_preprocessor": {
      "type": "function",
      "id": "<string>",
      "version": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Most Braintrust endpoints are authenticated by providing your API key as a header Authorization: Bearer [api_key] to your HTTP request. You can create an API key in the Braintrust organization settings page.

Body

application/json

Any desired information about the new project object

​
name
string
required

Name of the project

Minimum string length: 1
​
description
string | null

Textual description of the project

​
org_name
string | null

For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, you may specify the name of the organization the project belongs in.

Response

Returns the new project object

​
id
string<uuid>
required

Unique identifier for the project

​
org_id
string<uuid>
required

Unique id for the organization that the project belongs under

​
name
string
required

Name of the project

​
description
string | null

Textual description of the project

​
created
string<date-time> | null

Date of project creation

​
deleted_at
string<date-time> | null

Date of project deletion, or null if the project is still active

​
user_id
string<uuid> | null

Identifies the user who created the project

​
settings
object