Errors

Ada’s API uses conventional HTTP response codes to indicate the success or failure of API requests. In general:

• Codes in the 2xx range indicate success
• Codes in the 4xx range indicate errors caused by the request
• Codes in the 5xx range indicate errors on our servers

HTTP status code summary

Error response format

All error responses follow this format:

1
{
2
  "errors": [
3
    {
4
      "type": "error_type",
5
      "message": "Human readable message",
6
      "details": "Optional, additional error details"
7
    }
8
  ]
9
}

Validation errors

For validation errors ("type": "validation_error"), details is always a list of error objects, or null when there is no field-level detail. Each error object contains:

• parameter: A JSON path identifying the field that failed validation (for example, $[0].knowledge_source_id).
• location: Where the parameter was found in the request (for example, body).
• message: A human-readable description of the problem.

1
{
2
  "errors": [
3
    {
4
      "type": "validation_error",
5
      "message": "invalid articles data",
6
      "details": [
7
        {
8
          "parameter": "$[0].knowledge_source_id",
9
          "location": "body",
10
          "message": "Knowledge source with id 'bogus_id' does not exist."
11
        }
12
      ]
13
    }
14
  ]
15
}