Hyperdocs

Error Codes

The Hyperdocs API uses conventional HTTP response codes. Codes in the 2xx range indicate success, 4xx indicate a client error, and 5xx indicate a server error.

Error Response Shape

json
{
  "error": {
    "code": "not_found",
    "message": "The requested resource was not found.",
    "status": 404
  }
}

Common Codes

Code

HTTP Status

Description

unauthorized

401

Missing or invalid API key

forbidden

403

Insufficient permissions

not_found

404

Resource does not exist

rate_limited

429

Too many requests