Skip to main content

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Body

application/json
strategy
enum<string>

ocr recognizes text and tables from the rendered pages; deterministic converts the text embedded in the file. Defaults to ocr for PDF, PNG and JPEG, and deterministic otherwise.

Available options:
ocr,
deterministic
fallback_strategy
enum<string>

A different strategy to try once if the first finds no text. Omit for no fallback.

Available options:
ocr,
deterministic

Response

The text already exists. text_url returns a download link to it.

status
enum<string>
required
Available options:
ready
text_url
string
required

API path that returns a download link to the text.