Skip to main content

​
Parameters

All conversion endpoints share the same public parameters. In POST /convert and POST /convert/raw they go in the query string; in POST /convert/from-url they can go in the JSON body or query string.

​
Common parameters

​
string
default:"document.pdf"
Document name. It helps detect the format and names the output. Used by /convert/raw and /convert/from-url.
​
enum
default:"auto"
Force input format. With auto, the API detects it from filename and content type.
​
enum
default:"fast"
Conversion strategy: fast, balanced, quality, or auto. See Modes.
​
boolean
default:"true"
Cleans repeated headers, control lines and excess line breaks.
​
enum
default:"markdown"
markdown returns the Markdown body. json returns structured metadata with the Markdown. See Response.

​
Streaming-only parameters

POST /convert/stream accepts, in addition to filename, input_format, clean and slim:
​
enum
default:"sampled"
How repeated headers and footers are reduced when slim=true:
  • off: fastest first byte, minimal cleanup.
  • sampled: default balance for long PDFs.
  • full: best cleanup, higher startup time.
A value outside {off, sampled, full} returns 400.

​
input_format values

See Supported formats.

​
mode values

​
Output to your storage

​
string
Pre-signed PUT URL from your storage. If provided, the API uploads the converted Markdown there and returns a small JSON response instead of returning the full Markdown body.
​
enum
default:"identity"
Compression for uploaded Markdown: identity, gzip, or zstd. See Compression.
​
string
Pre-signed HEAD URL used to check whether the output already exists before converting again.

​
Precedence in from-url

In POST /convert/from-url, if a parameter arrives both by query and JSON body, the query value wins. Missing values use the body value or the default.