Skip to navigation
OCR API Reference

Get caller identity and usage

Your organization, key, scopes, credit, and recent usage.

usage_ocr_pages and usage_events count the OCR pages recorded for your organization since usage_since. The credit and usage fields are null when the server does not keep an account for the key.

Authentication

AuthorizationBearer

An emtelligent API key, sent as Authorization: Bearer <key>.

Response

Successful Response
org_idstring
owner_idstring
scopeslist of strings
soft_limitboolean
staleboolean
credit_remaining_centsdouble or nullOptional
usage_ocr_pagesinteger or nullOptional
usage_eventsinteger or nullOptional
usage_sincestring or nullOptional

Errors

401
Unauthorized Error
402
Payment Required Error
503
Service Unavailable Error