Assisters API
API Reference

API Keys

Programmatically create, list, update, and revoke your API keys

API Keys Management

Manage the API keys on your account. These management endpoints are authenticated with your dashboard session (cookie-based), not with an API key, and live under api.assisters.dev/api/keys rather than the /v1 data plane.

The full secret key is returned only once, at creation time. Store it securely — it is never shown again. A maximum of 10 active keys is allowed per account.

List API Keys

Endpoint

GET https://api.assisters.dev/api/keys

Returns up to 100 of your active API keys, newest first. Secrets are never included.

Response

[
  {
    "id": "a1b2c3d4-...",
    "name": "Production",
    "key_prefix": "ask_a1b2",
    "scopes": ["chat", "read"],
    "last_used_at": "2026-06-10T08:00:00.000Z",
    "expires_at": null,
    "is_active": true,
    "created_at": "2026-06-01T08:00:00.000Z"
  }
]

Response Fields

idstring

Unique identifier for the API key.

namestring

The human-readable name of the key.

key_prefixstring

The non-secret prefix of the key, used to identify it.

scopesarray

The scopes granted to the key — any of chat, read, write.

last_used_atstring

ISO 8601 timestamp of the last request made with this key, or null.

expires_atstring

ISO 8601 expiry timestamp, or null if the key never expires.

is_activeboolean

Whether the key is currently active.

created_atstring

ISO 8601 timestamp of when the key was created.

Create an API Key

Endpoint

POST https://api.assisters.dev/api/keys

Request Body

stringrequired

A human-readable name for the key. Maximum 255 characters.

arraydefault: ['chat', 'read']

The scopes to grant. Any of chat, read, write. Defaults to chat and read.

string

Optional ISO 8601 expiry timestamp. The key never expires if omitted.

Response

Returns 201 Created with the key record and the full secret (key) — shown only this once.

{
  "id": "a1b2c3d4-...",
  "name": "Production",
  "key_prefix": "ask_a1b2",
  "scopes": ["chat", "read"],
  "expires_at": null,
  "created_at": "2026-06-11T12:00:00.000Z",
  "key": "ask_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

Update an API Key

Endpoint

PATCH https://api.assisters.dev/api/keys/{id}

Request Body

Supply only the fields you want to change.

string

A new name for the key.

array

Replacement scopes. Any of chat, read, write, admin.

boolean

Set to false to deactivate the key without deleting it.

Response

{
  "success": true
}

Delete an API Key

Endpoint

DELETE https://api.assisters.dev/api/keys/{id}

Permanently revokes the key. This cannot be undone.

Response

{
  "success": true
}

Error Responses

Service Status

Check live API uptime and incidents