Брз почеток
Креирајте API клуч, па испратете датотека. Новите сметки започнуваат со 50 бесплатни кредити.
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"
}'Барање
POST https://api.ocrrouter.ai/v1/ocr со JSON тело и заглавие Authorization: Bearer.
| model | string | ID на моделот како што е mistral/mistral-ocr, или auto. |
| file_url | string | Јавно достапно URL на PDF или слика. Користете едно од file_url, file_base64 или file_id. |
| file_base64 | string | Датотеката како base64, до 20 MB. |
| file_id | string | ID вратено од POST /v1/files, за поголеми датотеки. |
| format | string | markdown (стандардно), json, text, html, csv, docx или xlsx. |
| pages | string | Опсег на страници, на пример 1-5,8. Стандардно се сите страници. |
| fallbacks | string[] | ID-ја на модели што треба да се пробаат, по редослед, ако првиот модел падне. |
| route | string | Со модел auto: quality (стандардно), cheapest или fastest. |
| filename | string | Изборно име прикажано во вашиот дневник на активности. |
Други крајни точки:
GET /v1/modelsги наведува сите модели, нивната цена и дали се достапни. Не е потребен клуч.POST /v1/filesприфаќа multipart прикачување со полеfileи враќаfile_idкое важи 24 часа.GET /v1/requests/:idвраќа претходен резултат. Додајте?format=со кој било излезен формат за да го добиете во друг.GET /v1/creditsго враќа вашето салдо и искористеноста на овој клуч.POST /v1/keys/temporaryвраќа привремен клуч со 50 кредити. Без регистрација, по еден на ден.
Излезни формати
markdown
Целиот документ како Markdown. Табелите се во GitHub формат, формулите се обвиткани во $...$, а страниците се одделени со <!-- page:N -->.
json
Истата структура од секој модел: страници, секоја со типизирани блокови. Типовите блокови се heading, paragraph, list, table, formula, image, header и footer. bbox, confidence и големината на страницата се null кога моделот не ги обезбедува, што е случај за моментално достапните модели.
{"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
Markdown одговорот плус објект output што содржи датотека: format, filename, mime_type, encoding и data. text, html и csv се UTF-8 низи (encoding: "utf8"); docx и xlsx се base64 (encoding: "base64"). csv и xlsx ги содржат табелите (еден лист по табела), или текстуалните редови кога нема табели. txt се прифаќа како друго име за 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}}Рутирање и резервни варијанти
Поставете го model на auto и ние избираме модел за секој документ. Користете route за да одредите што е најважно: cheapest, fastest или quality.
Додајте fallbacks за да продолжите со работа дури и при прекини. Ако првиот модел врати грешка или го надмине лимитот, се извршува следниот. Одговорот ви кажува кој модел одговорил, и плаќате само за него.
{"model": "mistral/mistral-ocr","fallbacks": ["google/gemini-flash", "tesseract/tesseract"],"file_url": "https://example.com/report.pdf"}Кредити
Секој модел има цена во кредити по страница. $1 купува 1,000 кредити и тие никогаш не истекуваат. Секој одговор вклучува usage.credits.
- Неуспешните и празните резултати се бесплатни.
- Повторното испраќање на истата датотека до истиот модел се испорачува од кеш бесплатно.
- Секој API клуч може да има сопствен лимит на кредити.
Грешки
Агенти, MCP и CLI
Агентите за кодирање можат да го користат OCRRouter без чекор за регистрација. CLI и MCP серверот бараат привремен клуч со 50 кредити при првата употреба и го зачувуваат во ~/.ocrrouter/config.json. Поставете OCRROUTER_API_KEY за да користите сопствен клуч.
# CLI
npx ocrrouter invoice.pdf --format markdown
# MCP server for Claude Code
claude mcp add ocrrouter -- npx ocrrouter mcpМашински читливо резиме на оваа страница се наоѓа на /llms.txt.