Skip to main content

Create API Key

Create a new API key for programmatic access
1 min read
post/api/v1/user/api-keys
Request example
Response
post/api/v1/user/api-keys
Warning

The full key is only returned once at creation. Store it immediately in a secrets manager or environment variable — it cannot be retrieved again.

Authentication#

This endpoint requires a valid user session token. If you do not yet have an API key, obtain a session token by logging in first and pass it as a Bearer token in the Authorization header.

Step 1 — Log in to get a session token

The response contains a token field. Use it in the next step.

Step 2 — Create an API key

Once you have an API key, you can use X-API-Key: <key> in place of Authorization: Bearer for all subsequent requests.

Headers

authorizationstring · null#
X-API-Keystring · null#

Body

application/json
namestringrequired#

Responses

application/json
Successful Response
idintegerrequired#
namestringrequired#
key_prefixstringrequired#
api_keystringrequired#
created_atstringrequired#