Sign in
Authentication

Create API key

Generate an API key for the user, used via the X-Api-Key header. Generating a new key deletes the previous one. Never use an API key from a front-end application.

Copy as Markdown Open in ChatGPT Open in Claude

post/v1/users/api-keys

Request body

passwordstring password required

The user's password.

Example request

{
  "password": "password"
}

Response

The generated API key (shown in full only once)

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "api_key": "mIpe_zdJfKUpMK9Va3XuYgzPXMxz49fIaRCWXseVkpVAX608A9j3i_D67qU5qW3M"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.