All requests below will use this key. Your API key is sent directly to api.cueapi.ai and never stored by the docs site.
API Overview
Base URL, authentication, rate limits, and error format.
Base URL
https://api.cueapi.ai
All API endpoints are prefixed with /v1/ except health checks.
Authentication
Most endpoints require a Bearer token in the Authorization header:
Authorization: Bearer cue_sk_YOUR_API_KEY
Endpoints that do not require authentication:
GET /health— system diagnosticsGET /status— lightweight health checkPOST /v1/auth/device-code— create device codePOST /v1/auth/device-code/poll— poll device codePOST /v1/auth/device-code/submit-email— submit emailGET /v1/auth/verify— magic link verification
Rate limits
Requests are rate-limited per plan using a sliding window:
| Plan | Limit |
|---|---|
| Free | 60 req/min |
| Pro | 200 req/min |
| Scale | 500 req/min |
Rate limit headers are included on every response:
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
Retry-After: 12 (only on 429)
When exceeded, the API returns 429 Too Many Requests.
Error format
All errors follow a consistent JSON structure:
json
{
"error": {
"code": "cue_not_found",
"message": "Cue not found: cue_abc123def456",
"status": 404
}
}See Error Codes for the complete list.
Request limits
- Body size: 2 MB maximum (returns
413 Payload Too Large) - Webhook timeout: 30 seconds
- Outcome metadata: 10 KB maximum
Endpoints
Cues
| Method | Path | Description |
|---|---|---|
| POST | /v1/cues | Create a cue |
| GET | /v1/cues | List cues |
| GET | /v1/cues/{cue_id} | Get cue detail |
| PATCH | /v1/cues/{cue_id} | Update cue |
| DELETE | /v1/cues/{cue_id} | Delete cue |
Executions
| Method | Path | Description |
|---|---|---|
| GET | /v1/executions/claimable | List claimable (worker) |
| POST | /v1/executions/{id}/claim | Claim execution (worker) |
| POST | /v1/executions/{id}/outcome | Report outcome |
Auth
| Method | Path | Description |
|---|---|---|
| GET | /v1/auth/me | Current user info |
| POST | /v1/auth/key/regenerate | Regenerate API key |
| GET | /v1/auth/webhook-secret | Get webhook secret |
| POST | /v1/auth/webhook-secret/regenerate | Rotate webhook secret |
Billing
| Method | Path | Description |
|---|---|---|
| POST | /v1/billing/checkout | Start Stripe checkout |
| POST | /v1/billing/portal | Open billing portal |
Usage
| Method | Path | Description |
|---|---|---|
| GET | /v1/usage | Usage statistics |
Worker
| Method | Path | Description |
|---|---|---|
| POST | /v1/worker/heartbeat | Worker liveness |
Health
| Method | Path | Description |
|---|---|---|
| GET | /health | Full diagnostics |
| GET | /status | Simple status |