Skip to main content
POST
Create an API key

Authorizations

X-API-KEY
string
header
required

Your access token, from your dashboard under API keys.

Body

application/json
name
string
required

Your name for the key.

Maximum string length: 100
Example:

"Production"

Response

The key.

object
string
Allowed value: "ApiKey"
id
string

pk_…

name
string
prefix
string

The first characters, to recognise the key.

role
string
Allowed value: "service"
issued_at
string<date-time>
last_used_at
string<date-time> | null
key
string

The access token. Shown once.