Referencia

#Referencia

Clientes

import markpdf

client = markpdf.Client(
    api_key="YOUR_API_KEY",     # or MARKPDF_API_KEY environment variable
    base_url="https://api.markpdf.tech",  # optional, production default
    timeout=300,               # segundos, default 300
    max_retries=2,             # reintentos automáticos en 429/5xx
)

import markpdf

client = markpdf.AsyncClient(
    api_key="YOUR_API_KEY",
    base_url="https://api.markpdf.tech",
    timeout=300,
    max_retries=2,
)

string

requerido

Su clave API. Si no lo pasa, el cliente lee MARKPDF_API_KEY del entorno.

string

predeterminado:"https://api.markpdf.tech"

URL base de API. Cámbielo solo si usa su propio proxy.

float

predeterminado:"300"

Tiempo de espera en segundos por solicitud HTTP. Los documentos grandes en mode=quality pueden tardar más; súbelo si lo necesitas.

integer

predeterminado:"2"

Reintentos automáticos con retroceso exponencial en 429 y 5xx. Consulte Manejo de errores.

AsyncClient implementa el protocolo de administrador de contexto asíncrono (async with) para cerrar con éxito la sesión HTTP. Client también admite with.

Métodos comunes a ambos clientes.

Todos los métodos aceptan los mismos parámetros con nombre que la conversión API. AsyncClient expone la misma firma que await.

`convert_file`

client.convert_file(
    path: str | Path,
    *,
    input_format: str = "auto",
    mode: str = "fast",
    engine: str = "auto",
    clean: bool = True,
    response_format: str = "markdown",
    pages: str | None = None,
    output_url: str | None = None,
    output_encoding: str = "identity",
    output_head_url: str | None = None,
    auto_poll: bool = True,
) -> str | ConversionResult

Cargue un archivo local en POST /convert/raw con el contenido comprimido en gzip si supera 1 MB (transparente, no requiere configuración). Devuelve str con Markdown, o ConversionResult si response_format="json".

str | Path

requerido

Ruta al archivo local.

boolean

predeterminado:"true"

Si el servidor responde 202 (backends saturados), SDK sondea automáticamente desde GET /jobs/{id} a completed o failed. Con auto_poll=Failedse, el método convierte MarkpdfJobQueuedError con job_id para que puedas realizar la encuesta tú mismo. Consulte Transmisión y asíncrono.

`convert_from_url`

client.convert_from_url(
    url: str,
    *,
    filename: str | None = None,
    input_format: str = "auto",
    mode: str = "fast",
    engine: str = "auto",
    clean: bool = True,
    response_format: str = "markdown",
    pages: str | None = None,
    output_url: str | None = None,
    output_encoding: str = "identity",
    output_head_url: str | None = None,
    auto_poll: bool = True,
) -> str | ConversionResult

Llame a POST /convert/from-url. url debe ser un URL prefirmado al que pueda acceder HTTPS.

`convert_stream`

client.convert_stream(
    path: str | Path | None = None,
    *,
    url: str | None = None,
    filename: str | None = None,
    input_format: str = "auto",
    clean: bool = True,
    slim: bool = True,
    stream_slim_strategy: str = "sampled",
) -> Iterator[str]  # AsyncIterator[str] en AsyncClient

Devuelve un iterador que produce fragmentos de Markdown a medida que llegan a través de streaming (POST /convert/stream o /convert/stream-from-url dependiendo de los pases path o url). Consulte Transmisión y asíncrono.

`pdf_index`

client.pdf_index(url: str, *, filename: str | None = None) -> PdfSpine

Llame a POST /pdf/index. Devuelve un objeto PdfSpine escrito con page_count, sections, pages, font_model, estimated_tokens_full, etc., los mismos campos documentados por POST /pdf/index.

spine = client.pdf_index("https://bucket.example.com/report.pdf?sig=...")
for section in spine.sections:
    print(section.page, section.level, section.text)

`get_job`

client.get_job(job_id: str) -> JobStatus

Consulta manualmente GET /jobs/{id}. JobStatus.status es uno de "queued", "processing", "completed", "failed". Cuando status == "completed", JobStatus.body contiene el resultado original (Markdown o JSON según los parámetros de la conversión en cola).

Tipos de devolución

`ConversionResult`

str

Documento convertido.

str

Nombre del documento procesado.

str

Formato detectado o forzado.

str

Motor que produjo la salida.

int

Introduzca el tamaño del documento.

int

Tamaño de reducción de salida.

int

Tokens guardados estimados versus documento sin procesar.

Timings

convert_ms, clean_ms, total_worker_ms, upload_ms, total_request_ms.

`PdfSpine`

int

list[Section]

Cada Section tiene page, level, text.

list[PageInfo]

Cada PageInfo tiene page, chars, first_line, headings.

bool

int

`JobStatus`

str

"queued", "processing", "completed" o "failed".

str | dict | None

Presente solo cuando status == "completed".

str | None

Presente solo cuando status == "failed".

Python

Node.js / TypeScript

C++

Next.js

Angular

React

React Native

Svelte

Bun

Flutter

Java

Kotlin

Clientes

Métodos comunes a ambos clientes.

`convert_file`

`convert_from_url`

`convert_stream`

`pdf_index`

`get_job`

Tipos de devolución

`ConversionResult`

`PdfSpine`

`JobStatus`

​Clientes

​Métodos comunes a ambos clientes.

​convert_file

​convert_from_url

​convert_stream

​pdf_index

​get_job

​Tipos de devolución

​ConversionResult

​PdfSpine

​JobStatus

Clientes

Métodos comunes a ambos clientes.

`convert_file`

`convert_from_url`

`convert_stream`

`pdf_index`

`get_job`

Tipos de devolución

`ConversionResult`

`PdfSpine`

`JobStatus`