API: Error Reference

Error Response Format

All errors return a JSON object with a single error field:

{
  "error": "Human-readable error message."
}

Status Code Reference

• 200 OK — Request succeeded.
• 201 Created — Resource created successfully.
• 202 Accepted — Async operation queued; poll /v1/runs/:runId for status.
• 400 Bad Request — Missing or invalid request body fields.
• 401 Unauthorized — API key is missing, invalid, or revoked.
• 403 Forbidden — Your plan does not include API access.
• 404 Not Found — Resource does not exist or belongs to a different account.
• 429 Too Many Requests — Daily rate limit exceeded.
• 500 Internal Server Error — Unexpected server failure.

Rate Limit Headers on 429

A 429 response includes headers to help you back off:

• X-RateLimit-Limit — your plan's daily call limit
• X-RateLimit-Remaining — always 0 when 429 is returned
• Retry-After — seconds until the daily counter resets

404 Error Messages

Each 404 identifies the missing resource:

• "Project not found." — project ID is missing or unauthorized.
• "Page not found." — page ID not in project.
• "Page set not found." — page set not in project.
• "Run not found." — run ID not scoped to your account.
• "Report not found." — report ID not in project.