Skip to content
Dials Docs

Errors

Every failure returns JSON in one shape: a rejected parameter, an unknown path, a fault on our side alike. There are no HTML error pages anywhere on the API.

{
  "error": "not_found",
  "message": "Brand not found.",
  "hint": "Check the slug against GET /brands.",
  "docs": "https://api.dials.co/docs"
}

error is the stable, machine-readable part and is safe to branch on:

CodeMeaning
invalid_requestA parameter or the path shape was rejected
unauthorizedThe endpoint needs a session you do not have
forbiddenThe session exists but may not do this
not_foundThe resource does not exist
rate_limitedOver budget; see rate limits
internal_errorOur fault; safe to retry with backoff

message is prose and may be reworded. hint says what to change about the request.