Skip to main content
Read the text of a document or agreement contract

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

Query Parameters

strategy
enum<string>
Available options:
ocr,
deterministic
offset
integer | null
default:0

Where to start, in characters. Continue with next_offset from the preceding slice.

Required range: 0 <= x <= 9007199254740991
limit
integer
default:40000

Maximum characters to return.

Required range: 100 <= x <= 40000
expected_version
string

Version from the preceding slice. When sent, the read fails if the text has changed.

Pattern: ^[a-f0-9]{64}$

Response

A slice of the text, where the next one starts and which extraction produced it.

source_version
string
required
Maximum string length: 1024
strategy
enum<string>
required
Available options:
ocr,
deterministic
verification
object
required
content_type
enum<string>
required
Available options:
text/markdown
origin
enum<string>
required
Available options:
extracted
text
string
required
Maximum string length: 40000
offset
integer
required
Required range: x >= 0
next_offset
integer | null
required
Required range: x >= 0
total
integer
required

Length of the whole text, in characters.

Required range: x >= 0
version
string
required
Pattern: ^[a-f0-9]{64}$