Skip to main content

Resumen de la API

La API expone tres formas de convertir un documento a Markdown, más un endpoint de estado. Todo responde text/markdown por defecto, o JSON si lo pides.

Base URL

Autenticación

Todas las llamadas usan x-api-key. Ver Autenticación.

Endpoints

POST /convert

Sube el archivo como multipart/form-data.

POST /convert/raw

Envía el binario crudo en el cuerpo. Soporta gzip y zstd.

POST /convert/from-url

Convierte desde una URL firmada de S3, R2, Supabase, GCS o Azure.

GET /jobs/{id}

Estado de una conversión encolada automáticamente (202).

GET /

Estado del servicio y formatos soportados.

Parámetros

Referencia completa de query params, modos y formatos.

Respuesta

Headers de observabilidad y cuerpo JSON.

Las tres rutas de conversión

Para documentos grandes, from-url suele ganar: tu servidor no recibe ni reenvía el mismo archivo dos veces.

Modelo de respuesta

Por defecto recibes Markdown crudo (text/markdown; charset=utf-8) más headers de observabilidad. Con response_format=json recibes un objeto con el Markdown y la metadata embebida. Ver Respuesta y headers.

Códigos de estado

Detalle en Errores.