Environments

Create environment

Changed on

Create a new environment

post/environment

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Request body

namestring required

Name of the environment

slugstring required

A url-friendly, unique identifier for the environment within an organization

descriptionstring nullable

Textual description of the environment

org_namestring nullable

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 environment belongs in.

Response

Created environment

idstring uuid required

Unique identifier for the environment

org_idstring uuid required

Unique identifier for the organization that the environment belongs under

namestring required

Name of the environment

slugstring required

A url-friendly, unique identifier for the environment within an organization

descriptionstring nullable

Textual description of the environment

createdstring date-time nullable

Date of environment creation

deleted_atstring date-time nullable

Date of environment deletion, or null if the environment is still active

Changes