OCRZero

Referencia de la API de Xiaomi-OCR-0

Crea una clave en la página de claves de API y envíala como token Bearer en la cabecera Authorization. Claves de API

POST /api/v1/ocr

  • mode: page (una imagen a Markdown), pdf (cada página del PDF a Markdown, hasta 20 páginas), kie (campos a JSON), vqa (pregunta a respuesta corta).
  • file: data URL en base64: PNG, JPEG o WebP de hasta 10 MB; PDF de hasta 25 MB en el modo pdf.
  • fields: lista opcional de nombres de campo para kie.
  • question: obligatorio para vqa.

Facturación

1 crédito = 1 página. Un PDF usa 1 crédito por página; una imagen usa 1 crédito para OCR de página, extracción de campos o una pregunta. Las páginas fallidas se reembolsan en la misma respuesta, en credits.refunded y en la cabecera X-OCRZero-Credits-Refunded. Ver precios

cURL

curl --fail-with-body https://ocrzero.com/api/v1/ocr \
  -H "Authorization: Bearer $OCRZERO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mode":"page","file":"data:image/png;base64,'"$(base64 < page.png | tr -d '\n')"'"}'

Python: campos de factura a JSON

import base64, os, requests

with open("invoice.jpg", "rb") as f:
    data = "data:image/jpeg;base64," + base64.b64encode(f.read()).decode()

r = requests.post("https://ocrzero.com/api/v1/ocr",
    headers={"Authorization": f"Bearer {os.environ['OCRZERO_API_KEY']}"},
    json={"mode": "kie", "file": data, "fields": ["invoice_number", "total_amount"]})
r.raise_for_status()
print(r.json()["json"])

Python: PDF a Markdown

import base64, os, requests

with open("report.pdf", "rb") as f:
    data = "data:application/pdf;base64," + base64.b64encode(f.read()).decode()

r = requests.post("https://ocrzero.com/api/v1/ocr",
    headers={"Authorization": f"Bearer {os.environ['OCRZERO_API_KEY']}"},
    json={"mode": "pdf", "file": data}, timeout=600)
r.raise_for_status()
body = r.json()
print(body["credits"], body["failedPages"])
open("report.md", "w").write(body["markdown"])

Respuesta

{
  "object": "ocr.result",
  "model": "xiaomi-ocr-0",
  "id": "4b7c…",
  "mode": "pdf",
  "markdown": "<!-- page 1 -->\n\n# Annual report …",
  "pages": 12,
  "totalPages": 12,
  "failedPages": [],
  "credits": { "charged": 12, "refunded": 0 },
  "usage": { "prompt_tokens": 25824, "completion_tokens": 9310, "total_tokens": 35134 },
  "latency_ms": 18450
}

Las tablas se devuelven como HTML dentro del Markdown y las fórmulas como LaTeX, convertidas con el posprocesado oficial de Xiaomi-OCR-0.

Errores

  • 401 falta la clave de API o no es válida.
  • 402 no hay créditos suficientes para las páginas de la solicitud.
  • 413 archivo demasiado grande; 422 solicitud no válida o archivo ilegible.
  • 429 límite de solicitudes alcanzado; 502/503 servidor del modelo no disponible. Los créditos se devuelven.

Xiaomi-OCR-0 es de código abierto con licencia Apache-2.0. OCRZero es independiente y no está afiliado a Xiaomi.