Create an API key

Creates an API key with the provided name and type. The API key is returned in the response.

POST /v1/api_keys

cURL

cURL

curl --request POST \
--url https://api.baseten.co/v1/api_keys \
--header "Authorization: Bearer $BASETEN_API_KEY" \
--data '{
  "name": "my-api-key",
  "type": "PERSONAL"
}'

200

{
  "api_key": "<string>"
}

Authorizations

Authorization · string · header · required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Body

application/json

Request to create an API key.

type · enum<string> · required

Type of the API key.

Available options: PERSONAL, WORKSPACE_MANAGE_ALL, WORKSPACE_EXPORT_METRICS, WORKSPACE_INVOKE

Examples:

"PERSONAL"

"WORKSPACE_EXPORT_METRICS"

"WORKSPACE_INVOKE"

"WORKSPACE_MANAGE_ALL"

name · string | null

Optional name for the API key

Example:

"my-api-key"

model_ids · string[] | null

List of model IDs to scope the API key to, only present if type is 'WORKSPACE_EXPORT_METRICS' or 'WORKSPACE_INVOKE'

Example:

["aaaaaaaa"]

Response

200 - application/json

Represents an API key.

api_key · string · required

The API key string