Reference/API/Projects

List projects

List out all projects. The projects are sorted by creation date, with the most recently-created projects coming first

GET
/v1/project

Authorization

Authorization
Required
Bearer <token>

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.

In: header

Query Parameters

limitinteger

Limit the number of objects to return

Minimum: 0
starting_afterstring

Pagination cursor id.

For example, if the final item in the last page you fetched had an id of foo, pass starting_after=foo to fetch the next page. Note: you may only pass one of starting_after and ending_before

Format: "uuid"
ending_beforestring

Pagination cursor id.

For example, if the initial item in the last page you fetched had an id of foo, pass ending_before=foo to fetch the previous page. Note: you may only pass one of starting_after and ending_before

Format: "uuid"
idsAny properties in string, array<string>

Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times

project_namestring

Name of the project to search for

org_namestring

Filter search results to within a particular organization

curl -X GET "https://api.braintrust.dev/v1/project?limit=0&starting_after=497f6eca-6276-4993-bfeb-53cbbbba6f08&ending_before=497f6eca-6276-4993-bfeb-53cbbbba6f08&ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&project_name=string&org_name=string" \
  -H "Authorization: Bearer <token>"

Returns a list of project objects

{
  "objects": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
      "name": "string",
      "created": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
      "settings": {
        "comparison_key": "string",
        "baseline_experiment_id": "890cfac5-c29c-451f-88cf-bbab4c3dde66",
        "spanFieldOrder": [
          {
            "object_type": "string",
            "column_id": "string",
            "position": "string",
            "layout": "full"
          }
        ]
      }
    }
  ]
}

Create project

Create a new project. If there is an existing project with the same name as the one specified in the request, will return the existing project unmodified

POST
/v1/project

Authorization

Authorization
Required
Bearer <token>

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.

In: header

Request Body

application/jsonOptional

Any desired information about the new project object

name
Required
string

Name of the project

Minimum length: 1
org_namestring

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.

curl -X POST "https://api.braintrust.dev/v1/project" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "org_name": "string"
  }'

Returns the new project object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "settings": {
    "comparison_key": "string",
    "baseline_experiment_id": "890cfac5-c29c-451f-88cf-bbab4c3dde66",
    "spanFieldOrder": [
      {
        "object_type": "string",
        "column_id": "string",
        "position": "string",
        "layout": "full"
      }
    ]
  }
}

Get project

Get a project object by its id

GET
/v1/project/{project_id}

Authorization

Authorization
Required
Bearer <token>

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.

In: header

Path Parameters

project_id
Required
string

Project id

Format: "uuid"
curl -X GET "https://api.braintrust.dev/v1/project/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

Returns the project object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "settings": {
    "comparison_key": "string",
    "baseline_experiment_id": "890cfac5-c29c-451f-88cf-bbab4c3dde66",
    "spanFieldOrder": [
      {
        "object_type": "string",
        "column_id": "string",
        "position": "string",
        "layout": "full"
      }
    ]
  }
}

Partially update project

Partially update a project object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.

PATCH
/v1/project/{project_id}

Authorization

Authorization
Required
Bearer <token>

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.

In: header

Request Body

application/jsonOptional

Fields to update

namestring

Name of the project

settingsobject

Path Parameters

project_id
Required
string

Project id

Format: "uuid"
curl -X PATCH "https://api.braintrust.dev/v1/project/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "settings": {
      "comparison_key": "string",
      "baseline_experiment_id": "890cfac5-c29c-451f-88cf-bbab4c3dde66",
      "spanFieldOrder": [
        {
          "object_type": "string",
          "column_id": "string",
          "position": "string",
          "layout": "full"
        }
      ]
    }
  }'

Returns the project object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "settings": {
    "comparison_key": "string",
    "baseline_experiment_id": "890cfac5-c29c-451f-88cf-bbab4c3dde66",
    "spanFieldOrder": [
      {
        "object_type": "string",
        "column_id": "string",
        "position": "string",
        "layout": "full"
      }
    ]
  }
}

Delete project

Delete a project object by its id

DELETE
/v1/project/{project_id}

Authorization

Authorization
Required
Bearer <token>

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.

In: header

Path Parameters

project_id
Required
string

Project id

Format: "uuid"
curl -X DELETE "https://api.braintrust.dev/v1/project/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

Returns the deleted project object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "created": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "settings": {
    "comparison_key": "string",
    "baseline_experiment_id": "890cfac5-c29c-451f-88cf-bbab4c3dde66",
    "spanFieldOrder": [
      {
        "object_type": "string",
        "column_id": "string",
        "position": "string",
        "layout": "full"
      }
    ]
  }
}

On this page