Errors

The Playbooks API uses standard HTTP response codes to indicate the status of an API request. When an error occurs, the Playbooks API returns a plain { error } envelope for client-side handling.

Attributes

AttributeTypeDescription
StatusintegerThe HTTP response code
TitlestringA title for the error
DescriptionstringA message describing the error
SourcestringOptional client-facing location
DebugstringOptional diagnostic metadata

Request

Request
  curl --location "https://api.playbooks.ai/error"

Response

Response
  {
      "error": {
          "status": 404,
          "title": "Not Found",
          "description": "Sorry that route doesn't exist.",
          "debug": "err_123456"
      }
  }