Skip to main content
POST
/
api-keys
/
{
  "id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "is_active": true,
  "api_key": "<string>"
}

Body

application/json
​
name
string
required

Response

Successful Response

Response when creating a new API key - includes the actual key value.

This is the only time the raw API key is exposed. After creation, only the hashed version is stored and the raw key cannot be retrieved.

​
id
string
required

Unique API key identifier with 'apikey_' prefix

​
created_at
string<date-time>
required

When this API key was created

​
is_active
boolean
required

Whether this API key is currently valid and can be used

​
api_key
string
required

The actual API key value - store this securely as it cannot be retrieved later

​
name
string | null

Optional descriptive name for this API key

​
last_used_at
string<date-time> | null

When this API key was last used for authentication

⌘I