Skip to main content

​
Parámetros

Los tres endpoints de conversión comparten el mismo conjunto de parámetros. En POST /convert y POST /convert/raw van en query string; en POST /convert/from-url pueden ir en query o en el JSON body.

​
Query params

​
string
predeterminado:"document.pdf"
Nombre del documento. Ayuda a detectar el formato y nombra la salida. Solo en /convert/raw y /convert/from-url.
​
enum
predeterminado:"auto"
Fuerza el formato de entrada. Con auto se detecta por extensión y luego por content-type.
​
enum
predeterminado:"fast"
​
boolean
predeterminado:"true"
Limpia headers repetidos, líneas de control y exceso de saltos de línea.
​
enum
predeterminado:"markdown"
markdown devuelve el cuerpo crudo. json devuelve un objeto con metadata. Ver Respuesta.

​
Parámetros solo de streaming

POST /convert/stream acepta, además de filename, input_format, clean y slim:
​
enum
predeterminado:"sampled"
Cómo limpia cabeceras/pies cuando slim=true, sin sacrificar el TTFB:
  • off: streaming real página a página, sin detección de ruido (TTFB mínimo).
  • sampled: detecta cabeceras/pies muestreando las primeras N páginas (STREAM_SLIM_SAMPLE_PAGES, 20 por defecto) y luego emite por página. Equilibrio por defecto.
  • full: materializa el documento entero para la mejor detección de ruido (TTFB más alto).
Un valor fuera de {off, sampled, full} responde 400. La respuesta lleva el header X-PDF-Stream-Slim-Strategy. Ver Modos.

​
Valores de input_format

Ver Formatos soportados.

​
Valores de mode

​
Valores de engine

​
Salida BYOS (output_url)

​
string
URL PUT prefirmada de tu storage. Si la das, la API sube ahí el Markdown y devuelve un JSON pequeño en vez del Markdown por body. Auto-activa defaults BYOS: response_format=json, output_encoding=zstd, slim=true.
​
enum
predeterminado:"identity"
Compresión del Markdown subido: identity, gzip, zstd. Ver Compresión.
​
string
URL HEAD prefirmada para detectar cache hit ANTES de extraer. Si el objeto ya existe en tu storage, la API devuelve el output_url sin reprocesar.

​
Precedencia en from-url

En POST /convert/from-url, si un parámetro llega por query y por JSON body, gana el query. Lo que no envíes toma el valor del body o el default.