The Ocrolus API leverages a specific set of HTTP status codes to indicate the success or failure of an incoming request.
All requests that are successfully sent to our API return the HTTP status code 200 OK.
To diagnose requests that are experiencing server issues (a rare occurrence), use the following HTTP status codes:
| HTTP status code | Cause |
|---|---|
| 502 Bad Gateway | The Ocrolus public proxy is experiencing issues. |
| 503 Service Unavailable | The service is down for maintenance. |
| 504 Gateway Timeout | The service did not respond within a reasonable time. |
| 413 Payload Too Large | You're attempting to upload a file that's too large. See here for more information about what you can do. |
| 429 Too Many Requests | You've made too many API requests recently. See here for more information about our API Rate Limit policy. |
If processing a request generates an application error, the JSON response includes the error. For more information, see Ocrolus Status Codes.
If at first you don't succeed...
We suggest that your application retries requests that fail for reasons beyond its control, such as server or network issues. Every API has the occasional misstep, including Ocrolus; planning accordingly can make your product more resilient against unexpected errors.
If there's a problem with our API, we'll report it on our status page.