Skip to main content
POST
Best for a file you already hold.
Works without an API key within the free limits. See Rate limits.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

A value you choose for one call. Send the same key with the same method, path and body within 24 hours and the first answer comes back with idempotent-replayed: true, with the same cost headers and no second charge. A call that sends zeroDataRetention and answers with page data is not kept, so a retry runs again. Needs an API key.

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
formats
object · enum<string> · object[]

What to send back besides markdown: summary, html and rawHtml (HTML files only), links, images, or { type: json, schema or prompt }. markdown is always sent.

Required array length: 1 - 8 elements
parsers
object[]

How to read PDF pages. Other files ignore it.

Maximum array length: 1
onlyMainContent
boolean

For an HTML file: send false to keep navigation and footers. The default is true.

includeTags
string[]

For an HTML file: keep only what these CSS selectors match.

Maximum array length: 50
Minimum string length: 1
excludeTags
string[]

For an HTML file: drop what these CSS selectors match.

Maximum array length: 50
Minimum string length: 1
removeBase64Images
boolean

For an HTML file: send false to keep images that carry their data in the address.

zeroDataRetention
boolean
default:false

Send true to keep nothing from this call: no stored result is read or made, and nothing is logged. Adds $2 per 1,000 pages.

origin
string

Which client sent the call. Not used.

Maximum string length: 200
integration
string

Which integration sent the call. Not used.

Maximum string length: 200
fastMode
any

Page-read speed. Accepted so a client that always sends it works; a file has no page to apply it to, so it is not used.

mobile
any

Mobile page view. Accepted so a client that always sends it works; a file has no page to apply it to, so it is not used.

blockAds
any

Ad blocking. Accepted so a client that always sends it works; a file has no page to apply it to, so it is not used.

skipTlsVerification
any

TLS checks of a page. Accepted so a client that always sends it works; a file has no page to apply it to, so it is not used.

timeout
any

Page load time. Accepted so a client that always sends it works; a file has no page to apply it to, so it is not used.

headers
any

Page request headers. Accepted so a client that always sends it works; a file has no page to apply it to, so it is not used.

proxy
any

Page proxy. Accepted so a client that always sends it works; a file has no page to apply it to, so it is not used.

location
any

Page country and languages. Accepted so a client that always sends it works; a file has no page to apply it to, so it is not used.

profile
any

Saved browser profile. Accepted so a client that always sends it works; a file has no page to apply it to, so it is not used.

uploadRef
string

Instead of file: the uploadId that POST /v1/parse/upload-url returned, after the file was sent to its uploadUrl. The stored file is deleted when the parse ends.

Pattern: ^upl_[A-Za-z0-9_-]{16,64}$
file
string

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

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. Pages of a PDF with no text layer are read from their picture, up to 20 of them, at $2.50 per 1,000 pages.

Required range: 1 <= x <= 100
options
object

How to read the file and what to send back, with the same names scrape uses for a page.

Response

The data, and what this call cost in dollars.

success
boolean
required
data
object
required