Skip to main content
PATCH
/
v1
/
organization
/
{organization_id}
Partially update organization
curl --request PATCH \
  --url https://api.braintrust.dev/v1/organization/{organization_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "api_url": "<string>",
  "is_universal_api": true,
  "proxy_url": "<string>",
  "realtime_url": "<string>",
  "image_rendering_mode": "auto"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "api_url": "<string>",
  "is_universal_api": true,
  "proxy_url": "<string>",
  "realtime_url": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "image_rendering_mode": "auto"
}

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

​
organization_id
string<uuid>
required

Organization id

Body

application/json

Fields to update

​
name
string | null

Name of the organization

​
api_url
string | null
​
is_universal_api
boolean | null
​
proxy_url
string | null
​
realtime_url
string | null
​
image_rendering_mode
enum<string> | null

Controls how images are rendered in the UI: 'auto' loads images automatically, 'click_to_load' shows a placeholder until clicked, 'blocked' prevents image loading entirely

Available options:
auto,
click_to_load,
blocked,

Response

Returns the organization object

​
id
string<uuid>
required

Unique identifier for the organization

​
name
string
required

Name of the organization

​
api_url
string | null
​
is_universal_api
boolean | null
​
proxy_url
string | null
​
realtime_url
string | null
​
created
string<date-time> | null

Date of organization creation

​
image_rendering_mode
enum<string> | null

Controls how images are rendered in the UI: 'auto' loads images automatically, 'click_to_load' shows a placeholder until clicked, 'blocked' prevents image loading entirely

Available options:
auto,
click_to_load,
blocked,