Ocrolus API

Ocrolus API Documentation

Welcome to Ocrolus' API Documentation. You'll find comprehensive guides and documentation here to help you get started with the Ocrolus API. Let's jump right in!

HTTP Status Codes

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 CodeCause
502 Bad GatewayThe Ocrolus public proxy is experiencing issues.
503 Service UnavailableThe service is down for maintenance.
504 Gateway TimeoutThe service did not respond within a reasonable time.
429 Too Many RequestsThe user is being rate-limited by the Ocrolus proxy gateway.


Application error codes

If processing a request generates an application error, the JSON response includes the error. For more information, see Ocrolus Status Codes.

Updated 14 days ago

HTTP Status Codes

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.