If a request fails, the API returns a JSON response with additional information. The response includes the following keys:

  • id: Contains a UTF-8 string with the error type’s internal representation.
  • message: Contains a human-readable message describing the nature of the error.
  • detail: If present, contains additional information relating to the error. Each id has its own schema for the detail field.

In the following example, the id identifies the error as export_failure. The message provides a human-readable description you can display to end users or use for debugging. In this case, the detail field does not contain additional information.

{
    "id": "export_failure",
    "message": "Export failed on account of server error",
    "detail": null
}