Skip to main content
GET
/
v1
/
api_key
/
{api_key_id}
Get api_key
curl --request GET \
  --url https://api.braintrust.dev/v1/api_key/{api_key_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "preview_name": "<string>",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_email": "<string>",
  "user_given_name": "<string>",
  "user_family_name": "<string>",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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

​
api_key_id
string<uuid>
required

ApiKey id

Response

Returns the api_key object

​
id
string<uuid>
required

Unique identifier for the api key

​
name
string
required

Name of the api key

​
preview_name
string
required
​
created
string<date-time> | null

Date of api key creation

​
user_id
string<uuid> | null

Unique identifier for the user

​
user_email
string | null

The user's email

​
user_given_name
string | null

Given name of the user

​
user_family_name
string | null

Family name of the user

​
org_id
string<uuid> | null

Unique identifier for the organization