Rychlý start
Vytvořte si API klíč a odešlete soubor. Nové účty začínají s 50 bezplatnými kredity.
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"
}'Požadavek
POST https://api.ocrrouter.ai/v1/ocr s tělem v JSON a hlavičkou Authorization: Bearer.
| model | string | ID modelu, například mistral/mistral-ocr, nebo auto. |
| file_url | string | Veřejná URL adresa PDF nebo obrázku. Použijte jeden z parametrů: file_url, file_base64 nebo file_id. |
| file_base64 | string | Soubor ve formátu base64, do 20 MB. |
| file_id | string | ID vrácené z POST /v1/files, pro větší soubory. |
| format | string | markdown (výchozí), json, text, html, csv, docx nebo xlsx. |
| pages | string | Rozsah stran, například 1-5,8. Výchozí jsou všechny strany. |
| fallbacks | string[] | Seznam ID modelů k vyzkoušení popořadě, pokud první model selže. |
| route | string | Při modelu auto: quality (výchozí), cheapest nebo fastest. |
| filename | string | Volitelný název zobrazený v protokolu aktivit. |
Další koncové body:
GET /v1/modelsvypíše všechny modely, jejich cenu a dostupnost. Není vyžadován žádný klíč.POST /v1/filespřijímá multipart upload s polemfilea vracífile_id, které je platné 24 hodin.GET /v1/requests/:idvrátí dřívější výsledek. Přidejte?format=s libovolným výstupním formátem a získejte jej v jiném formátu.GET /v1/creditsvrátí váš zůstatek a využití tohoto klíče.POST /v1/keys/temporaryvrátí dočasný klíč s 50 kredity. Bez registrace, jeden denně.
Výstupní formáty
markdown
Celý dokument ve formátu Markdown. Tabulky odpovídají GitHub Markdownu, vzorce jsou uzavřeny v $...$ a stránky jsou odděleny <!-- page:N -->.
json
Jednotná struktura pro každý model: stránky, každá s typovanými bloky. Typy bloků jsou heading, paragraph, list, table, formula, image, header a footer. bbox, confidence a velikost stránky mají hodnotu null, pokud je model neposkytuje, což je případ dnes dostupných modelů.
{"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
Odpověď v Markdownu plus objekt output obsahující soubor: format, filename, mime_type, encoding a data. text, html a csv jsou řetězce v UTF-8 (encoding: "utf8"); docx a xlsx jsou base64 (encoding: "base64"). csv a xlsx obsahují tabulky (jeden list na tabulku), případně textové řádky, pokud v dokumentu žádné tabulky nejsou. txt je přijímán jako alternativní název pro text.
{"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}}Směrování a zálohy
Nastavte model na auto a my vybereme model pro každý dokument. Pomocí route určete prioritu: cheapest, fastest nebo quality.
Přidejte fallbacks, abyste předešli výpadkům. Pokud první model selže nebo narazí na limit požadavků, spustí se další. Odpověď uvádí, který model odpověděl, a platíte pouze za něj.
{"model": "mistral/mistral-ocr","fallbacks": ["google/gemini-flash", "tesseract/tesseract"],"file_url": "https://example.com/report.pdf"}Kredity
Každý model má stanovenou cenu v kreditech za stránku. Za 1 $ získáte 1,000 kreditů a jejich platnost nevyprší. Každá odpověď obsahuje usage.credits.
- Neúspěšné a prázdné výsledky jsou zdarma.
- Opětovné odeslání stejného souboru stejnému modelu se načte z mezipaměti zdarma.
- Každý API klíč může mít vlastní limit kreditů.
Chyby
Agenti, MCP a CLI
Programovací agenti mohou OCRRouter používat bez registrace. CLI a MCP server při prvním použití požádají o dočasný klíč s 50 kredity a uloží jej do ~/.ocrrouter/config.json. Chcete-li použít vlastní klíč, nastavte proměnnou OCRROUTER_API_KEY.
# CLI
npx ocrrouter invoice.pdf --format markdown
# MCP server for Claude Code
claude mcp add ocrrouter -- npx ocrrouter mcpStrojově čitelný souhrn této stránky najdete na /llms.txt.