Reference/API/Organizations
GET
/v1/organization

List organizations

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

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

org_namestring

Filter search results to within a particular organization

Status codeDescription
200Returns a list of organization objects
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something 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 a 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 codeDescription
200Returns the organization object
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something 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 a 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

namestring | null

Name of the organization

api_urlstring | null

is_universal_apiboolean | null

proxy_urlstring | null

realtime_urlstring | null

Path Parameters

organization_id
Required
string

Organization id

Format: "uuid"
Status codeDescription
200Returns the organization object
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something 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 a 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 codeDescription
200Returns the deleted organization object
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something 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

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

Users to invite to the organization

remove_usersobject | null

Users to remove from the organization

org_namestring | 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_idstring | 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 codeDescription
200A success status
400The request was unacceptable, often due to missing a required parameter
401No valid API key provided
403The API key doesn’t have permissions to perform the request
429Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500Something 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_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"
}

On this page