Skip to main content
PATCH
/
v1
/
ai_secret
/
{ai_secret_id}
Partially update ai_secret
curl --request PATCH \
  --url https://api.braintrust.dev/v1/ai_secret/{ai_secret_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "metadata": {},
  "secret": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "type": "<string>",
  "metadata": {},
  "preview_secret": "<string>"
}

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.

Path Parameters

​
ai_secret_id
string<uuid>
required

AiSecret id

Body

application/json

Fields to update

​
name
string | null

Name of the AI secret

​
type
string | null
​
metadata
object
​
secret
string | null

Response

Returns the ai_secret object

​
id
string<uuid>
required

Unique identifier for the AI secret

​
org_id
string<uuid>
required

Unique identifier for the organization

​
name
string
required

Name of the AI secret

​
created
string<date-time> | null

Date of AI secret creation

​
updated_at
string<date-time> | null

Date of last AI secret update

​
type
string | null
​
metadata
object
​
preview_secret
string | null