For the complete documentation index, see llms.txt. This page is also available as Markdown.

Error Responses

Errors are returned as HTTP codes in the 4XX range. All errors are accompanied by a JSON response that provides the details of the error so corrective action can be taken.

    {
      "errors": [
        {
          "source": {
            "pointer": "a JSON Pointer RFC6901 to the associated entity in the request document E.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute.",
            "parameter": "a string indicating which URI query parameter caused the error."
          },
          "detail": "<long error message>",
          "status": "<error code - same as HTTP status code>",
          "title": "<brief error message - typically same as the HTTP status title>"
        },
        ...
      ]
    }

See the documentation for the individual endpoint for the specifics of the errors that apply to that endpoint.

Last updated

Was this helpful?