Skip to main content
PUT
/
v1
/
env_var
Create or replace env_var
curl --request PUT \
  --url https://api.braintrust.dev/v1/env_var \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "object_type": "organization",
  "object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "value": "<string>",
  "metadata": {},
  "secret_type": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object_type": "organization",
  "object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "used": "2023-11-07T05:31:56Z",
  "metadata": {},
  "secret_type": "<string>",
  "secret_category": "env_var"
}

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 env_var object

​
object_type
enum<string>
required

The type of the object the environment variable is scoped for

Available options:
organization,
project,
function
​
object_id
string<uuid>
required

The id of the object the environment variable is scoped for

​
name
string
required

The name of the environment variable

​
value
string | null

The value of the environment variable. Will be encrypted at rest.

​
metadata
object

Optional metadata associated with the environment variable when managed via the function secrets API

​
secret_type
string | null

Optional classification for the secret (for example, the AI provider name)

Response

Returns the new env_var object

​
id
string<uuid>
required

Unique identifier for the environment variable

​
object_type
enum<string>
required

The type of the object the environment variable is scoped for

Available options:
organization,
project,
function
​
object_id
string<uuid>
required

The id of the object the environment variable is scoped for

​
name
string
required

The name of the environment variable

​
created
string<date-time> | null

Date of environment variable creation

​
used
string<date-time> | null

Date the environment variable was last used

​
metadata
object

Optional metadata associated with the environment variable when managed via the function secrets API

​
secret_type
string | null

Optional classification for the secret (for example, the AI provider name)

​
secret_category
enum<string>
default:env_var

The category of the secret: env_var for regular environment variables, ai_provider for AI provider API keys

Available options:
env_var,
ai_provider