OCRRouter

API dokumentáció

Útmutatók a legfontosabb fogalmakhoz. Minden végpont és paraméter megtalálható az API-referenciában.

Gyorstalpaló

Hozz létre egy API-kulcsot, majd küldj egy fájlt. Az új fiókok 50 ingyenes kredittel indulnak.

curl https://api.ocrrouter.ai/v1/ocr \
  -H "Authorization: Bearer $OCRROUTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "auto",
    "file_url": "https://example.com/invoice.pdf",
    "format": "markdown"
  }'

Kérés

POST https://api.ocrrouter.ai/v1/ocr egy JSON törzzsel és egy Authorization: Bearer fejléccel.

modelstringEgy modellazonosító, például mistral/mistral-ocr, vagy auto.
file_urlstringEgy PDF vagy kép nyilvános URL-je. A file_url, file_base64 vagy file_id egyikét használd.
file_base64stringA fájl base64 formátumban, legfeljebb 20 MB-ig.
file_idstringA POST /v1/files által visszaadott azonosító nagyobb fájlokhoz.
formatstringmarkdown (alapértelmezett), json, text, html, csv, docx vagy xlsx.
pagesstringOldaltartomány, például 1-5,8. Alapértelmezés szerint az összes oldal.
fallbacksstring[]Kipróbálandó modellazonosítók sorrendben, ha az első modell hibát jelezne.
routestringAz auto modell esetén: quality (alapértelmezett), cheapest vagy fastest.
filenamestringOpcionális név, amely megjelenik a tevékenységnaplóban.

További végpontok:

  • A GET /v1/models felsorolja az összes modellt, azok árát és elérhetőségét. Kulcs nem szükséges hozzá.
  • A POST /v1/files egy többrészes (multipart) feltöltést fogad egy file mezővel, és egy 24 óráig érvényes file_id-t ad vissza.
  • A GET /v1/requests/:id egy korábbi eredményt ad vissza. A ?format= paraméterrel bármilyen más kimeneti formátumban is lekérheted.
  • A GET /v1/credits visszaadja az egyenlegedet és az adott kulcs használatát.
  • A POST /v1/keys/temporary egy 50 kredites ideiglenes kulcsot ad vissza. Regisztráció nem szükséges, naponta egy kérhető.

Kimeneti formátumok

markdown

A teljes dokumentum Markdown formátumban. A táblázatok GitHub-féle táblázatok, a képletek $...$ közé vannak zárva, az oldalakat pedig a <!-- page:N --> választja el.

json

Ugyanaz a struktúra minden modelltől: oldalak, mindegyik típusos blokkokkal. A blokktípusok: heading, paragraph, list, table, formula, image, header és footer. A bbox, a confidence és az oldalméret null értékű, ha a modell nem adja meg őket – a jelenleg futó modellek esetében ez a helyzet.

200result
{"id": "req_8f2c1a41d0b3c7e9a2","model": "mistral/mistral-ocr","format": "json","attempts": [{ "model": "mistral/mistral-ocr", "ok": true, "ms": 1180 }],"pages": [{"index": 1,"width": null,"height": null,"blocks": [{"type": "heading","level": 1,"text": "Invoice INV-2041","bbox": null,"confidence": null},{"type": "paragraph","text": "Acme Supply Co.\n14 Harbour Street, Sydney NSW 2…","bbox": null,"confidence": null},{"type": "table","rows": [["Item", "Qty", "Unit price", "Amount"],["A4 paper, 5 reams", "4", "$24.00", "$96.00"]],"markdown": "| Item | Qty | Unit price | Amount |\n|---|---|-…","bbox": null,"confidence": null}]}],"usage": {"pages": 1,"credits": 25,"latency_ms": 1180,"cached": false}}

text, html, csv, docx, xlsx

A Markdown válasz kiegészítve egy output objektummal, amely a fájlt tartalmazza: format, filename, mime_type, encoding és data. A text, html és csv UTF-8 karakterláncok (encoding: "utf8"); a docx és xlsx base64 kódolásúak (encoding: "base64"). A csv és xlsx a táblázatokat tartalmazza (táblázatonként egy munkalap), vagy a szövegsorokat, ha nincsenek táblázatok. A txt a text szinonimájaként is használható.

200result
{"id": "req_8f2c1a41d0b3c7e9a2","model": "mistral/mistral-ocr","format": "docx","attempts": [{ "model": "mistral/mistral-ocr", "ok": true, "ms": 1180 }],"markdown": "<!-- page:1 -->\n# Invoice INV-2041\n…","pages": [{ "index": 1, "markdown": "# Invoice INV-2041\n…" }],"output": {"format": "docx","filename": "invoice.docx","mime_type": "application/vnd.openxmlformats-officedocument.w…","encoding": "base64","data": "UEsDBBQAAAAIA…"},"usage": {"pages": 1,"credits": 25,"latency_ms": 1180,"cached": false}}

Útválasztás és tartalékok

Állítsd a model értékét auto-ra, és minden dokumentumhoz kiválasztjuk a legmegfelelőbb modellt. A route paraméterrel megadhatod a prioritást: cheapest, fastest vagy quality.

Állíts be fallbacks listát, hogy a leállások alatt is működjön a feldolgozás. Ha az első modell hibát dob vagy sebességkorlátba ütközik, a következő fut le. A válaszból kiderül, melyik modell válaszolt, és csak azért az egyért fizetsz.

{"model": "mistral/mistral-ocr","fallbacks": ["google/gemini-flash", "tesseract/tesseract"],"file_url": "https://example.com/report.pdf"}

Kreditek

Minden modellnek oldalankénti kreditára van. 1 dollárért 1,000 kredit vásárolható, és nem járnak le. Minden válasz tartalmazza a usage.credits mezőt.

  • A sikertelen és üres eredmények ingyenesek.
  • Ha ugyanazt a fájlt ugyanazzal a modellel küldöd el újra, a gyorsítótárból (cache) szolgáljuk ki ingyen.
  • Minden API-kulcshoz egyedi kreditkeret állítható be.

Hibák

400Hibás kérés, vagy a fájltípus nem támogatott.
401Az API-kulcs hiányzik vagy vissza lett vonva.
402Nincs elég kredit, vagy a kulcs elérte a kreditkeretét.
413A fájl meghaladja az adott modellhez engedélyezett méretkorlátot.
429Túl sok kérés. Próbáld újra a Retry-After fejlécben megadott idő elteltével.
502A tartaléklánc összes modellje hibát jelzett. Nem terhelünk díjat.
503A kért modell még nincs csatlakoztatva.

Ágensek, MCP és CLI

A kódoló ágensek regisztráció nélkül is használhatják a(z) OCRRouter oldalt. A CLI és az MCP szerver az első használatkor egy 50 kredites ideiglenes kulcsot igényel, és elmenti a ~/.ocrrouter/config.json fájlba. Ha a saját kulcsodat szeretnéd használni, állítsd be az OCRROUTER_API_KEY környezeti változót.

# CLI
npx ocrrouter invoice.pdf --format markdown

# MCP server for Claude Code
claude mcp add ocrrouter -- npx ocrrouter mcp

Az oldal géppel olvasható összefoglalója itt található: /llms.txt.

Gyakori kérdések