Error Reference

Error Format

Every error includes three tiers:

{
  "error": {
    "type": "invalid_date_range",
    "message": "start_date must be before end_date",
    "display_message": "The date range is invalid.",
    "suggestion": "Swap: start_date=2026-03-10&end_date=2026-03-17",
    "param": "start_date",
    "docs_url": "https://suna.health/docs/api/errors"
  }
}
FieldFor
messageDevelopers — debug context
display_messageEnd users — safe to show in UI
suggestionAI agents — machine-actionable fix

Error Types

HTTPTypeWhen
400invalid_requestBad params, missing fields
400invalid_date_rangestart > end
401unauthorizedMissing/invalid API key
401key_revokedRevoked key
403insufficient_scopeMissing scope
404not_foundResource doesn't exist
429rate_limitedOver limit (Retry-After header)
500internal_errorServer error
503not_availablePlaceholder endpoint