Skip to content

Error codes

API errors return a JSON object with a human-readable error field:

{"error":"Authentication required"}

Plan limit errors also include upgrade_url:

{
"error": "Plan limit reached",
"upgrade_url": "https://app.myhypedoc.com/settings"
}
StatusMeaningTypical cause
400Bad requestMalformed JSON or request
401UnauthenticatedMissing or invalid bearer token
402Payment requiredFree plan limit reached
403ForbiddenAuthenticated user lacks permission
404Not foundResource is missing or not visible
422Validation failedInvalid field, date, or state
429Rate limitedRequest limit exceeded

The API uses 404 for resources that the caller cannot see, which avoids revealing whether another user owns them.

HTTP/1.1 401 Unauthorized
Content-Type: application/json
{"error":"Authentication required"}

Create a new token with the email code flow or in Settings.

HTTP/1.1 402 Payment Required
Content-Type: application/json
{
"error": "Plan limit reached",
"upgrade_url": "https://app.myhypedoc.com/settings"
}

The free plan allows 50 billable wins and 3 owned spaces. The limit is charged to the space owner.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
{"error":"Body cannot be blank"}

Use the message to correct the request, then retry.

A 429 response includes Retry-After in seconds. See Rate limits.