Skip to main content
The full REST API. Every endpoint, every parameter, every response shape — auto-generated from openapi.yaml and always in sync with production.

Base URL

https://api.asyncbase.dev

Auth

Every /v1/* endpoint requires a Bearer token:
Authorization: Bearer sk_live_...
Get a key at /settings/api-keys. Rotate via POST /v1/api-keys/rotate — old key stays valid for a 1-hour grace window unless revoke_immediately: true.

Endpoint groups

Queue messages

/v1/queues/{name}/messages — enqueue, pull, ack, nack, heartbeat

Dead letter queue

/v1/queues/{name}/dlq — list, redrive

Live tail (SSE)

/v1/queues/{name}/tail — real-time observer stream

Queue config

/v1/queues — CRUD queue metadata

API keys

/v1/api-keys/rotate — rotate + revoke

Alerts

/v1/alerts — webhook rules, DLQ threshold

Usage + audit

/v1/usage, /v1/audit — month counters + mutation log

Health

/health — public liveness probe (no auth)

Downloads

OpenAPI YAML

openapi.yaml

OpenAPI JSON

openapi.json

llms.txt (for AI)

LLM-optimized doc index

Rate limits

Planreq/sBehavior
free10429 with Retry-After: 1
pro100same
scale2,000same
Every /v1 response (2xx and 429) carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset headers.

Error envelope

Every non-2xx response:
{
  "error": {
    "code": "CONSTANT_CASE_CODE",
    "message": "Human-readable one-liner",
    "docs": "https://asyncbase.dev/docs/errors/..."
  }
}
See errors.md for the full enum (14 codes).