BRbraintrustdata
ApiKeys

Get API key

Changed on

Get an API key object by its id

get/v1/api_key/{api_key_id}

Request

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

Path parameters

api_key_idstring uuid required

ApiKey id

Response

Returns the API key object

idstring uuid required

Unique identifier for the api key

createdstring date-time nullable

Date of api key creation

namestring required

Name of the api key

preview_namestring required

Masked preview showing the key prefix and last four characters, e.g. sk-…AbCd.

user_idstring uuid nullable

Unique identifier for the user

user_emailstring nullable

The user's email

user_given_namestring nullable

Given name of the user

user_family_namestring nullable

Family name of the user

org_idstring uuid nullable

Unique identifier for the organization

expires_atstring date-time nullable

Date at which the API key expires. If null, the key never expires.

Changes

  • e05ef145579dRevision changes
    • info

      added the optional property to the response with the status

  • 77a2d5797d94Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status