OCRZero

Referência da API do Xiaomi-OCR-0

Crie uma chave na página de chaves de API e envie-a como token Bearer no cabeçalho Authorization. Chaves de API

POST /api/v1/ocr

  • mode: page (uma imagem para Markdown), pdf (cada página do PDF para Markdown, até 20 páginas), kie (campos para JSON), vqa (pergunta para resposta curta).
  • file: data URL em base64: PNG, JPEG ou WebP de até 10 MB; PDF de até 25 MB no modo pdf.
  • fields: lista opcional de nomes de campos para kie.
  • question: obrigatório para vqa.

Cobrança

1 crédito = 1 página. Um PDF usa 1 crédito por página; uma imagem usa 1 crédito para OCR de página, extração de campos ou uma pergunta. Páginas com falha são reembolsadas na mesma resposta, em credits.refunded e no cabeçalho X-OCRZero-Credits-Refunded. Ver preços

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 fatura para 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 para 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"])

Resposta

{
  "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
}

As tabelas voltam como HTML dentro do Markdown e as fórmulas como LaTeX, convertidas com o pós-processamento oficial do Xiaomi-OCR-0.

Erros

  • 401 chave de API ausente ou inválida.
  • 402 créditos insuficientes para as páginas da solicitação.
  • 413 arquivo grande demais; 422 solicitação inválida ou arquivo ilegível.
  • 429 limite de solicitações atingido; 502/503 servidor do modelo indisponível. Os créditos são devolvidos.

O Xiaomi-OCR-0 é de código aberto sob a licença Apache-2.0. O OCRZero é independente e não é afiliado à Xiaomi.