Reference/API/Ai Secrets

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

GET /v1/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

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

ai_secret_namestring

Name of the ai_secret to search for

org_namestring

Filter search results to within a particular organization

ai_secret_typeAny properties in string, array<string>
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" \
  -H "Authorization: Bearer <token>"

Returns a list of ai_secret objects

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

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

POST /v1/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

application/jsonOptional

Any desired information about the new ai_secret object

name
Required
string

Name of the AI secret

typestring
metadataobject
secretstring

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

org_namestring

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.

curl -X POST "https://api.braintrust.dev/v1/ai_secret" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "type": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "secret": "string",
    "org_name": "string"
  }'

Returns the new ai_secret object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "2019-08-24T14:15:22Z",
  "updated_at": "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 single ai_secret

Delete a single ai_secret

DELETE /v1/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

application/jsonOptional

Parameters which uniquely specify the ai_secret to delete

name
Required
string

Name of the AI secret

org_namestring

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.

curl -X DELETE "https://api.braintrust.dev/v1/ai_secret" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "org_name": "string"
  }'

Returns the deleted ai_secret object

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

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

PUT /v1/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

application/jsonOptional

Any desired information about the new ai_secret object

name
Required
string

Name of the AI secret

typestring
metadataobject
secretstring

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

org_namestring

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.

curl -X PUT "https://api.braintrust.dev/v1/ai_secret" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "type": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "secret": "string",
    "org_name": "string"
  }'

Returns the new ai_secret object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "2019-08-24T14:15:22Z",
  "updated_at": "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 ai_secret

Get an ai_secret object by its id

GET /v1/ai_secret/{ai_secret_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"
curl -X GET "https://api.braintrust.dev/v1/ai_secret/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

Returns the ai_secret object

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

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.

PATCH /v1/ai_secret/{ai_secret_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

Request Body

application/jsonOptional

Fields to update

namestring

Name of the AI secret

typestring
metadataobject
secretstring

Path Parameters

ai_secret_id
Required
string

AiSecret id

Format: "uuid"
curl -X PATCH "https://api.braintrust.dev/v1/ai_secret/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "type": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "secret": "string"
  }'

Returns the ai_secret object

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created": "2019-08-24T14:15:22Z",
  "updated_at": "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 ai_secret

Delete an ai_secret object by its id

DELETE /v1/ai_secret/{ai_secret_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"
curl -X DELETE "https://api.braintrust.dev/v1/ai_secret/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Authorization: Bearer <token>"

Returns the deleted ai_secret object

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

On this page