Skip to main content
PUT
/
v1
/
service_token
Create or replace service_token
curl --request PUT \
  --url https://api.braintrust.dev/v1/service_token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "service_account_id": "<string>",
  "org_name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "preview_name": "<string>",
  "key": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "service_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "service_account_email": "<string>",
  "service_account_name": "<string>",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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.

Body

application/json

Any desired information about the new service_token object

​
name
string
required

Name of the service token. Does not have to be unique

​
service_account_id
string
required

The service account ID this service token should belong to. You can create a service account in the Braintrust organization settings page or using the modify organization membership endpoint

​
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, you may specify the name of the organization the Service token belongs in.

Response

Returns an object containing the raw service token. This is the only time the raw API key will be exposed

​
id
string<uuid>
required

Unique identifier for the service token

​
name
string
required

Name of the service token

​
preview_name
string
required
​
key
string
required

The raw service token. It will only be exposed this one time

​
created
string<date-time> | null

Date of service token creation

​
service_account_id
string<uuid> | null

Unique identifier for the service token

​
service_account_email
string | null

The service account email (not routable)

​
service_account_name
string | null

The service account name

​
org_id
string<uuid> | null

Unique identifier for the organization