Skip to content

Markdown Source

Use the raw markdown for copy, automation, and AI agents.

View Markdown

APIKey API

Create API Key

prolog
POST API_BASE/apikeys

Authorization Required

OAuthAPIKey
NoNo

Request Body

json
{
  "name": "My Key"
}

Response

json
{
  "data": APIKeyObject,
  "ts": 1723923923
}

List API Keys

prolog
GET API_BASE/apikeys

Authorization Required

OAuthAPIKey
YesYes

OAuth scope: apikey.read

Response

json
{
  "data": [APIKeyObject, ...],
  "ts": 1723923923
}

Delete API Key

prolog
DELETE API_BASE/apikeys/:id

Authorization Required

OAuthAPIKey
NoNo

Parameters

ParameterTypeDescription
iduint64The ID of the API key

Response

json
{
  "data": APIKeyObject,
  "ts": 1723923923
}

Verify API Key Hash

prolog
POST API_BASE/apikeys/verify

Authorization Required

OAuthAPIKey
YesYes

OAuth scope: apikey.read

Request Body

json
{
  "hash": "sha256_hex_of_apikey"
}

Response

json
{
  "data": {
    "valid": true
  },
  "ts": 1723923923
}