Create My Api Key

POST

/auth/api-keys/

curl --request POST \
  --url https://example.com/api/auth/api-keys/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Create an API key for the current user.

The raw key is returned only in this response and cannot be retrieved again.

Authorizations

• OAuth2PasswordBearer

Request Body ^required

Media type application/json

ApiKeyCreateRequest

object

name

required

Name

Human-readable label for the API key

string

>= 1 characters <= 255 characters

Example ^generated

{
  "name": "example"
}

Responses

201

Successful Response

Media type application/json

ApiKeyCreateResponse

object

id

required

Id

string format: uuid

key

required

Key

The API key secret (shown only once)

string

name

required

Name

string

created_at

required

Created At

string format: date-time

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "key": "example",
  "name": "example",
  "created_at": "2026-04-15T12:00:00Z"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}