Skip to main content
POST
document.parse

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
url
string

Public URL of the document. Send this, content or fileId.

content
string

The file's bytes, base64-encoded, up to 10 MiB. Send this, url or fileId.

fileId
string

Id of an uploaded file holding the document, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
extension
string

File type of content, like "pdf" or "docx".

Required string length: 1 - 8
Pattern: ^[a-z0-9]{1,8}$
ocr
boolean
default:false

Read text from images and scanned pages. Default false.

Response

The result

text
string
required

The document's text.

truncated
boolean
required

True when the text was cut to fit the size limit.