Api Keys

List all API keys for a user

get

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

idstring · uuidRequired

nameany ofRequired

stringOptional

or

nullOptional

previewstringRequired

user_idstring · uuidRequired

expires_atany ofRequired

string · date-timeOptional

or

nullOptional

createdstring · date-timeRequired

404

Not found

422

Validation Error

application/json

get

/api-keys

HTTPcURLJavaScriptPython

GET /api-keys HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "preview": "text",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "expires_at": "2026-03-09T12:56:29.100Z",
    "created": "2026-03-09T12:56:29.100Z"
  }
]

Create an API key for a user

post

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

nameany ofOptional

A human-readable name for the API key

stringOptional

or

nullOptional

expires_atany ofOptional

The date and time when the API key will expire

string · date-timeOptional

or

nullOptional

Responses

200

Successful Response

text/plain

stringOptional

404

Not found

422

Validation Error

application/json

post

/api-keys

HTTPcURLJavaScriptPython

POST /api-keys HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "name": "text",
  "expires_at": "2026-03-09T12:56:29.100Z",
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

text

Delete an API key

delete

Path parameters

api_key_idstring · uuidRequired

Header parameters

passwordany ofOptional

The password header to use to fetch the preview

stringOptional

or

nullOptional

Body

application/json

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

delete

/api-keys/{api_key_id}

HTTPcURLJavaScriptPython

DELETE /api-keys/{api_key_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "body": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content