OCRRouter

API документација

Водичи кроз основне концепте. Свака крајња тачка и параметар налазе се у API референци.

Брзи почетак

Креирајте 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.

modelstringID модела попут mistral/mistral-ocr, или auto.
file_urlstringЈавни URL за PDF или слику. Користите један од: file_url, file_base64 или file_id.
file_base64stringДатотека као base64, до 20 MB.
file_idstringID који враћа POST /v1/files, за веће датотеке.
formatstringmarkdown (подразумевано), json, text, html, csv, docx или xlsx.
pagesstringОпсег страница, на пример 1-5,8. Подразумевано све странице.
fallbacksstring[]ID-јеви модела које треба испробати редом ако први модел откаже.
routestringУз model auto: quality (подразумевано), cheapest или fastest.
filenamestringОпциони назив који се приказује у дневнику активности.

Остале крајње тачке:

  • 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 када их модел не пружа, што је случај са тренутно доступним моделима.

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

Markdown одговор плус објекат output који садржи датотеку: format, filename, mime_type, encoding и data. text, html и csv су UTF-8 стрингови (encoding: "utf8"); docx и xlsx су base64 (encoding: "base64"). csv и xlsx садрже табеле (један лист по табели), или текстуалне редове ако их нема. txt се прихвата као друго име за text.

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

Рутирање и резервни модели

Поставите 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 кључ може имати сопствени лимит кредита.

Грешке

400Захтев је неисправан или тип датотеке није подржан.
401API кључ недостаје или је опозван.
402Нема довољно кредита или је кључ достигао лимит потрошње.
413Датотека је већа од ограничења за овај модел.
429Превише захтева. Покушајте поново након времена наведеног у заглављу Retry-After.
502Сви резервни модели у ланцу су отказали. Ово се не наплаћује.
503Модел који сте тражили још увек није повезан.

Агенти, 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.

Питања