The page provides the description of expected errors of Claid API and guidance how to handle them.
The Claid API provides standard HTTP status codes. Every successful responses are indicated with a 200-series and error responses with non-200-series HTTP code.
Error reasons can vary, but the structure of the response always looks the following:
"error_message": "name: ensure this value has at most 50 characters. parameters.credentials.access_key: field required.",
"ensure this value has at most 50 characters"
error_codestring Claid internal error identifier.
error_typestring Claid errors are grouped by topics and this field returns the name of that group.
error_messagestring A human-readable description of the error. If there were several reasons for failure - they will be concatenated as separate sentences, divided with
error_detailsobject If there is a request validation error with
key:valuepairs - this field represents a nicely formatted version of
error_message. Otherwise it can be an empty object -
Error response example with an empty
"error_message": "Authorization is required.",
If you want to get a human-readable error message, then it is best to always get data from the
If you prefer to represent the error yourself according to the
key:valuepairs of errored fields, use
error_details. Note: It can be an empty object if there was no validation error associated with the field. In this case, you can get the message from the
Everything worked as expected
Since this is a generic error, there can be several reasons why we get it, such as when we can't get the object from storage, or can't even parse JSON payload when it's invalid.
In any case, you can get the error reason from
error_messageattribute. See the How to get error reason above.
402No API calls left
The API key doesn't have permissions to perform the request. We recommend checking the scopes and correctness of the API key.
The requested resource doesn't exist.
The request can't be processed, because of conflict in the current state of the resource.
The error indicates that the payload has logical or validation issues. The concrete reasons can be found in
429Too Many Requests
500Internal Server Error
Temporary error, which indicates that we experiencing an internal error.
This is a rare case but if you continue to receive this error, please reach out to API support with request details.
In case of any issues with image processing, you can reach out to our technical support and provide them details with
x-request-idheader value (see the API reference).