Omilia uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.), and codes in the 5xx range indicate an error with Omilia’s servers (these are rare).
Not all errors map cleanly onto HTTP response codes, however. To understand the source of the error please refer to the list of codes in the documentation.
The Omilia API uses the following error codes:
HTTP Error Codes
OK Everything worked as expected
Bad Request The request was unacceptable, often due to missing a required parameter
Unauthorized No valid API key provided
Request Failed The parameters were valid but the request failed
Not Found The requested resource doesn’t exist
Forbidden Most common example is "No available licenses"
Conflict The request conflicts with another request (perhaps due to using the same idempotent key)
Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests
500, 502, 503, 504
Server Errors Something went wrong on Omilia’s end