Skip to main content
POST
Best for a file you already hold. To read a page or a PDF by its address, use scrape.
Works without an API key, up to 10 calls a minute and 50 a day per IP. See Rate limits.

Price

1 credit per call. See Pricing for what credits cost.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

maxTextLength
integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json
file
string
required

The file's bytes as base64, up to 36 MB: a PDF, a Word .docx, an Excel .xlsx, a PowerPoint .pptx or an HTML file.

Minimum string length: 1
filename
string

The file's name, such as report.docx. The type is read from the file itself.

Required string length: 1 - 255
maxPages
integer
default:100

Read at most this many PDF pages, sheets or slides; isTruncated says when the file had more.

Required range: 1 <= x <= 100
zeroDataRetention
boolean
default:false

Send true to keep nothing from this call: no stored result is read or made, and nothing is logged. Costs 1 credit more.

Response

The data, and the credits this call used.

success
boolean
required
data
object