Ai Secrets - Docs - Braintrust

GET

/v1/ai_secret

List ai_secrets

List out all ai_secrets. The ai_secrets are sorted by creation date, with the most recently-created ai_secrets 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

`ai_secret_name`string

Name of the ai_secret to search for

`org_name`string

Filter search results to within a particular organization

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

Status code	Description
`200`	Returns a list of ai_secret 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/ai_secret?limit=0&starting_after=497f6eca-6276-4993-bfeb-53cbbbba6f08&ending_before=497f6eca-6276-4993-bfeb-53cbbbba6f08&ids=497f6eca-6276-4993-bfeb-53cbbbba6f08&ai_secret_name=string&org_name=string&ai_secret_type=string"

{
  "objects": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created": "2019-08-24T14:15:22Z",
      "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
      "name": "string",
      "type": "string",
      "metadata": {
        "property1": null,
        "property2": null
      },
      "preview_secret": "string"
    }
  ]
}

POST

/v1/ai_secret

Create ai_secret

Create a new ai_secret. If there is an existing ai_secret with the same name as the one specified in the request, will return the existing ai_secret unmodified

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)

Any desired information about the new ai_secret object

`name`
Required
string

Name of the AI secret

`type`string | null

`metadata`object | null

`secret`string | null

Secret value. If omitted in a PUT request, the existing secret value will be left intact, not replaced with null.

`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 AI Secret belongs in.

Status code	Description
`200`	Returns the new ai_secret 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 POST "https://api.braintrust.dev/v1/ai_secret" \
  -d '{
  "name": "string",
  "type": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "secret": "string",
  "org_name": "string"
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "2019-08-24T14:15:22Z",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "type": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "preview_secret": "string"
}

DELETE

/v1/ai_secret

Delete single ai_secret

Delete a single ai_secret

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)

Parameters which uniquely specify the ai_secret to delete

`name`
Required
string

Name of the AI secret

`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 AI Secret belongs in.

Status code	Description
`200`	Returns the deleted ai_secret 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/ai_secret" \
  -d '{
  "name": "string",
  "org_name": "string"
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "2019-08-24T14:15:22Z",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "type": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "preview_secret": "string"
}

PUT

/v1/ai_secret

Create or replace ai_secret

Create or replace ai_secret. If there is an existing ai_secret with the same name as the one specified in the request, will replace the existing ai_secret with the provided fields

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)

Any desired information about the new ai_secret object

`name`
Required
string

Name of the AI secret

`type`string | null

`metadata`object | null

`secret`string | null

Secret value. If omitted in a PUT request, the existing secret value will be left intact, not replaced with null.

`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 AI Secret belongs in.

Status code	Description
`200`	Returns the new ai_secret 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 PUT "https://api.braintrust.dev/v1/ai_secret" \
  -d '{
  "name": "string",
  "type": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "secret": "string",
  "org_name": "string"
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "2019-08-24T14:15:22Z",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "type": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "preview_secret": "string"
}

GET

/v1/ai_secret/{ai_secret_id}

Get ai_secret

Get an ai_secret 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

`ai_secret_id`
Required
string

AiSecret id

Format: "uuid"

Status code	Description
`200`	Returns the ai_secret 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/ai_secret/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "2019-08-24T14:15:22Z",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "type": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "preview_secret": "string"
}

PATCH

/v1/ai_secret/{ai_secret_id}

Partially update ai_secret

Partially update an ai_secret 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 AI secret

`type`string | null

`metadata`object | null

`secret`string | null

Path Parameters

`ai_secret_id`
Required
string

AiSecret id

Format: "uuid"

Status code	Description
`200`	Returns the ai_secret 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/ai_secret/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -d '{
  "name": "string",
  "type": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "secret": "string"
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "2019-08-24T14:15:22Z",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "type": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "preview_secret": "string"
}

DELETE

/v1/ai_secret/{ai_secret_id}

Delete ai_secret

Delete an ai_secret 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

`ai_secret_id`
Required
string

AiSecret id

Format: "uuid"

Status code	Description
`200`	Returns the deleted ai_secret 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/ai_secret/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "2019-08-24T14:15:22Z",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "type": "string",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "preview_secret": "string"
}

Query

AuthorizationRequiredBearer <token>

limitinteger | null

starting_afterstring

ending_beforestring

idsAny properties in string, array<string>

Object 1

ai_secret_namestring

org_namestring

ai_secret_typeAny properties in string, array<string>

Object 1

Response

Typescript

Body

AuthorizationRequiredBearer <token>

nameRequiredstring

typestring | null

metadataobject | null

metadata

secretstring | null

org_namestring | null

Response

Typescript

Body

AuthorizationRequiredBearer <token>

nameRequiredstring

org_namestring | null

Response

Typescript

Body

AuthorizationRequiredBearer <token>

nameRequiredstring

typestring | null

metadataobject | null

metadata

secretstring | null

org_namestring | null

Response

Typescript

Path

AuthorizationRequiredBearer <token>

ai_secret_idRequiredstring

Response

Typescript

Path

Body

AuthorizationRequiredBearer <token>

namestring | null

typestring | null

metadataobject | null

metadata

secretstring | null

ai_secret_idRequiredstring

Response

Typescript

Path

AuthorizationRequiredBearer <token>

ai_secret_idRequiredstring

Response

Typescript

On this page

Query

Body

Body

Body

Path

Path

Body

Path

`Authorization`
Required
Bearer <token>

`limit`integer | null

`starting_after`string

`ending_before`string

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

`ai_secret_name`string

`org_name`string

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

`Authorization`
Required
Bearer <token>

`name`
Required
string

`type`string | null

`metadata`object | null

`secret`string | null

`org_name`string | null

`Authorization`
Required
Bearer <token>

`name`
Required
string

`org_name`string | null

`Authorization`
Required
Bearer <token>

`name`
Required
string

`type`string | null

`metadata`object | null

`secret`string | null

`org_name`string | null

`Authorization`
Required
Bearer <token>

`ai_secret_id`
Required
string

`Authorization`
Required
Bearer <token>

`name`string | null

`type`string | null

`metadata`object | null

`secret`string | null

`ai_secret_id`
Required
string

`Authorization`
Required
Bearer <token>

`ai_secret_id`
Required
string