Errors

The shape#

{
  "error": {
    "code": "not_found",
    "message": "No item with the key \"model:isles:nothing/here\". Find keys with /api/v1/search?q=name."
  }
}

Match on code: the messages may be reworded.

Status codes#

• 200OKThe data.
• 304Not ModifiedYour If-None-Match matched: nothing changed, no body.
• 400bad_requestA parameter has a value it does not take; the message says what it does take.
• 401bad_keyAn API key was sent that is unknown or revoked.
• 404not_foundNo item, source or icon with that key or path.
• 405Method Not AllowedThe route does not take that method (all but /captures are GET).
• 429rate_limitedOver the limit; wait for Retry-After seconds. See Rate limits.
• 502unavailableThe sync service behind the mod routes and icons did not answer.
• 503unavailableThe catalogue could not be loaded. Rare; try again in a minute.