Skip to main content
POST
Parse a file
From 1 credit See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Query Parameters

extension
enum<string>

Optional file extension hint, such as pdf, docx, xlsx, pptx, html, json, csv, md, py, rtf, jpg, png, or txt.

Available options:
txt,
text,
md,
markdown,
html,
htm,
xhtml,
xml,
rss,
atom,
csv,
tsv,
yaml,
yml,
py,
java,
js,
jsx,
mjs,
cjs,
json,
jsonl,
ndjson,
php,
sh,
bash,
zsh,
fish,
rb,
ts,
tsx,
rtf,
srt,
css,
scss,
less,
styl,
sass,
svg,
pdf,
docx,
doc,
xlsx,
xlsm,
xlsb,
xltx,
xltm,
xls,
pptx,
pptm,
ppsx,
ppsm,
potx,
potm,
ppt,
pps,
pot,
jpg,
jpeg,
jpe,
png,
gif,
bmp,
tiff,
tif,
webp,
ppm,
pbm,
pgm,
pnm

Preserve hyperlinks in Markdown output

includeImages
boolean
default:false

Include image references in Markdown output

shortenBase64Images
boolean
default:true

Shorten base64-encoded image data in the Markdown output

useMainContentOnly
boolean
default:false

Extract only the main content from HTML-like inputs

ocr
boolean
default:false

Read text from images and scanned PDF pages. PDF page ranges still apply.

pdf
object

PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5}.

client
string

Optional client identifier used for usage attribution.

Required string length: 1 - 100
zdr
enum<string>
default:disabled

enabled turns on zero data retention. Returns 403 ZDR_NOT_ENABLED unless your organization has ZDR.

Available options:
enabled,
disabled
tags
string[]

Comma-separated labels for filtering usage, e.g. production,team-alpha. Labels for filtering usage in the dashboard.

Maximum array length: 20
Required string length: 1 - 50
Example:

Body

Raw file bytes, up to 50 MiB.

The body is of type file.

Response

Successful response

success
enum<boolean>
required

Indicates success

Available options:
true
markdown
string
required

Input bytes converted to GitHub Flavored Markdown

type
enum<string>
required

Detected content type used for parsing

Available options:
html,
xml,
json,
jsonl,
text,
csv,
tsv,
markdown,
yaml,
python,
java,
javascript,
php,
shell,
ruby,
typescript,
rtf,
srt,
css,
scss,
less,
stylus,
sass,
svg,
pdf,
docx,
doc,
xlsx,
xls,
pptx,
ppt,
jpg,
png,
gif,
bmp,
tiff,
webp,
ppm,
pbm,
pgm,
pnm
request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

key_metadata
object

Credits this request used and your remaining balance.