Skip to main content
POST
/
api
/
me
/
api-keys
Create My Api Key
curl --request POST \
  --url https://your-domain.com/api/me/api-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "key": "<string>",
  "key_prefix": "<string>",
  "created_at": "<string>",
  "scopes": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}

Body

application/json
name
string
required
Required string length: 1 - 100
scopes
string | null
expires_at
string<date-time> | null

Response

Successful Response

Returned only at creation time -- includes the full key.

id
string
required
name
string
required
key
string
required
key_prefix
string
required
created_at
string
required
scopes
string | null
expires_at
string<date-time> | null