Organizations - Docs

GET

/v1/organization

List organizations

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

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

`limit`integer | null

Limit the number of objects to return

Minimum: 0

`starting_after`string

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_before`string

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"

`ids`Any 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

`org_name`string

Filter search results to within a particular organization

Status code	Description
`200`	Returns a list of organization objects
`400`	The request was unacceptable, often due to missing a required parameter
`401`	No valid API key provided
`403`	The API key doesn’t have permissions to perform the request
`429`	Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
`500`	Something went wrong on Braintrust's end. (These are rare.)

curl -X GET "https://api.braintrust.dev/v1/organization?limit=0&starting_after=497f6eca-6276-4993-bfeb-53cbbbba6f08&ending_before=497f6eca-6276-4993-bfeb-53cbbbba6f08&ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&org_name=string"

{
  "objects": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "api_url": "string",
      "is_universal_api": true,
      "proxy_url": "string",
      "realtime_url": "string",
      "created": "2019-08-24T14:15:22Z"
    }
  ]
}

GET

/v1/organization/{organization_id}

Get organization

Get an organization object by its 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

`organization_id`
Required
string

Organization id

Format: "uuid"

Status code	Description
`200`	Returns the organization object
`400`	The request was unacceptable, often due to missing a required parameter
`401`	No valid API key provided
`403`	The API key doesn’t have permissions to perform the request
`429`	Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
`500`	Something went wrong on Braintrust's end. (These are rare.)

curl -X GET "https://api.braintrust.dev/v1/organization/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "api_url": "string",
  "is_universal_api": true,
  "proxy_url": "string",
  "realtime_url": "string",
  "created": "2019-08-24T14:15:22Z"
}

PATCH

/v1/organization/{organization_id}

Partially update organization

Partially update an organization 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.

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 (Optional)

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

Path Parameters

`organization_id`
Required
string

Organization id

Format: "uuid"

Status code	Description
`200`	Returns the organization object
`400`	The request was unacceptable, often due to missing a required parameter
`401`	No valid API key provided
`403`	The API key doesn’t have permissions to perform the request
`429`	Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
`500`	Something went wrong on Braintrust's end. (These are rare.)

curl -X PATCH "https://api.braintrust.dev/v1/organization/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -d '{
  "name": "string",
  "api_url": "string",
  "is_universal_api": true,
  "proxy_url": "string",
  "realtime_url": "string"
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "api_url": "string",
  "is_universal_api": true,
  "proxy_url": "string",
  "realtime_url": "string",
  "created": "2019-08-24T14:15:22Z"
}

DELETE

/v1/organization/{organization_id}

Delete organization

Delete an organization object by its 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

`organization_id`
Required
string

Organization id

Format: "uuid"

Status code	Description
`200`	Returns the deleted organization object
`400`	The request was unacceptable, often due to missing a required parameter
`401`	No valid API key provided
`403`	The API key doesn’t have permissions to perform the request
`429`	Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
`500`	Something went wrong on Braintrust's end. (These are rare.)

curl -X DELETE "https://api.braintrust.dev/v1/organization/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "api_url": "string",
  "is_universal_api": true,
  "proxy_url": "string",
  "realtime_url": "string",
  "created": "2019-08-24T14:15:22Z"
}

PATCH

/v1/organization/members

Modify organization membership

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 (Optional)

Members to add/remove

`invite_users`object | null

Users to invite to the organization

`remove_users`object | null

Users to remove from the organization

`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, or in case you want to explicitly assert the organization you are modifying, you may specify the name of the organization.

`org_id`string | null

For nearly all users, this parameter should be unnecessary. But in the rare case that your API key belongs to multiple organizations, or in case you want to explicitly assert the organization you are modifying, you may specify the id of the organization.

Status code	Description
`200`	A success status
`400`	The request was unacceptable, often due to missing a required parameter
`401`	No valid API key provided
`403`	The API key doesn’t have permissions to perform the request
`429`	Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
`500`	Something went wrong on Braintrust's end. (These are rare.)

curl -X PATCH "https://api.braintrust.dev/v1/organization/members" \
  -d '{
  "invite_users": {
    "ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "emails": [
      "string"
    ],
    "send_invite_emails": true,
    "group_ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "group_names": [
      "string"
    ],
    "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
    "group_name": "string"
  },
  "remove_users": {
    "ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "emails": [
      "string"
    ]
  },
  "org_name": "string",
  "org_id": "string"
}'

{
  "status": "success",
  "send_email_error": "string"
}

Query

AuthorizationRequiredBearer <token>

limitinteger | null

starting_afterstring

ending_beforestring

idsAny properties in string, array<string>

Object 1

org_namestring

Response

Typescript

Path

AuthorizationRequiredBearer <token>

organization_idRequiredstring

Response

Typescript

Path

Body

AuthorizationRequiredBearer <token>

namestring | null

api_urlstring | null

is_universal_apiboolean | null

proxy_urlstring | null

realtime_urlstring | null

organization_idRequiredstring

Response

Typescript

Path

AuthorizationRequiredBearer <token>

organization_idRequiredstring

Response

Typescript

Body

AuthorizationRequiredBearer <token>

invite_usersobject | null

invite_users

remove_usersobject | null

remove_users

org_namestring | null

org_idstring | null

Response

Typescript

On this page

Query

Path

Path

Body

Path

Body

`Authorization`
Required
Bearer <token>

`limit`integer | null

`starting_after`string

`ending_before`string

`ids`Any properties in string, array<string>

`org_name`string

`Authorization`
Required
Bearer <token>

`organization_id`
Required
string

`Authorization`
Required
Bearer <token>

`name`string | null

`api_url`string | null

`is_universal_api`boolean | null

`proxy_url`string | null

`realtime_url`string | null

`organization_id`
Required
string

`Authorization`
Required
Bearer <token>

`organization_id`
Required
string

`Authorization`
Required
Bearer <token>

`invite_users`object | null

`remove_users`object | null

`org_name`string | null

`org_id`string | null