Skip to main content
PATCH
/
v1
/
project
/
{project_id}
Partially update project
curl --request PATCH \
  --url https://api.braintrust.dev/v1/project/{project_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "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>"
      }
    ]
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<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>"
      }
    ]
  }
}

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.

Path Parameters

​
project_id
string<uuid>
required

Project id

Body

application/json

Fields to update

​
name
string | null

Name of the project

​
settings
object | null

Project settings. Patch operations replace all settings, so make sure you include all settings you want to keep.

Response

Returns the 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

​
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 | null