Skip to main content
PATCH
Partially update organization

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
is_dataplane_private
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,
null

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
is_dataplane_private
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,
null