API Reference

API Keys

API keys authenticate requests. Keys are hashed with SHA-256 before storage, so the raw token is only available at creation time. Create multiple keys for different bots or environments, and revoke them individually.

List API keys

GET /api/v1/api_keys

Returns all your keys. The raw token is never included in list responses.

Response 200

[
  {
    "id": 1,
    "name": "Claude Bot",
    "last_used_at": "2026-04-03T14:00:00Z",
    "created_at": "2026-04-01T..."
  },
  {
    "id": 2,
    "name": "CI Pipeline",
    "last_used_at": null,
    "created_at": "2026-04-02T..."
  }
]

Create an API key

POST /api/v1/api_keys

Parameter Type Description
namestringRequired. A label for the key.
Response 201

{
  "id": 3,
  "name": "New Bot",
  "token": "PspJWGiobMbKMrBUemVFbzUKN62CaFkc",
  "last_used_at": null,
  "created_at": "2026-04-03T..."
}

One-time only

The token field is only included in the creation response. It cannot be retrieved later. If lost, delete the key and create a new one.

Revoke an API key

DELETE /api/v1/api_keys/:id

Immediately revokes the key. Any requests using it will receive 401. Returns 204 No Content.

Previous
← Folders