API documentation

WorkoutDB ships a generated OpenAPI 3.1 spec with an interactive Scalar playground — try requests with your own key right in the browser.

Open interactive docs →OpenAPI 3.1 spec

Get started fast

Import the Postman collection to start sending requests in seconds, or point your AI agent at the docs below — they're self-contained and generated from the live spec.

Download Postman collection ↓OpenAPI 3.1 spec

For AI agents

These follow the llms.txt convention — a self-contained guide an agent can read and start calling the API.

/llms.txt — concise index with links.
/llms-full.txt — full reference: auth, envelope, errors, every endpoint with examples.

Quickstart

Sign up and create a key in the dashboard.
Send it as X-API-Key (or Authorization: Bearer).
Hitting an error? Include the X-Request-Id response header when contacting support.

Error reference

Every non-2xx response uses one envelope: { "error": { "code", "message", "details" }, "requestId" }. The code is stable — switch on it, not the message.

error.code	HTTP	Meaning
`invalid_request`	400	Malformed params, bad cursor, or unsupported ?lang.
`unauthorized`	401	Missing, unknown, or revoked API key.
`forbidden_plan`	403	Your plan does not allow this resource.
`not_found`	404	No exercise or taxonomy with that id/slug.
`rate_limited`	429	Per-minute rate limit exceeded — see Retry-After.
`quota_exceeded`	429	Monthly quota exhausted — see Retry-After, or upgrade.
`internal`	500	Unexpected server error — report with your X-Request-Id.

429 responses carry Retry-After (seconds). Authenticated responses include X-RateLimit-* and X-Quota-* headers, and every response carries X-Request-Id.