OCRRouter

API dokumentācija

Pamatjēdzienu ceļveži. Katrs galapunkts un parametrs ir atrodams API rokasgrāmatā.

Ātrā darba sākšana

Izveidojiet API atslēgu un nosūtiet failu. Jauni konti sāk ar 50 bezmaksas kredītiem.

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

Pieprasījums

POST https://api.ocrrouter.ai/v1/ocr ar JSON pamattekstu un Authorization: Bearer galveni.

modelstringModeļa ID, piemēram, mistral/mistral-ocr vai auto.
file_urlstringPublisks PDF vai attēla URL. Izmantojiet vienu no: file_url, file_base64 vai file_id.
file_base64stringFails base64 formātā, līdz 20 MB.
file_idstringID, ko atgriež POST /v1/files lielākiem failiem.
formatstringmarkdown (noklusējums), json, text, html, csv, docx vai xlsx.
pagesstringLappušu diapazons, piemēram, 1-5,8. Pēc noklusējuma visas lappuses.
fallbacksstring[]Modeļu ID saraksts secīgai mēģināšanai, ja pirmais modelis neizdodas.
routestringAr modeli auto: quality (noklusējums), cheapest vai fastest.
filenamestringNeobligāts nosaukums, kas redzams jūsu darbību žurnālā.

Citi galapunkti:

  • GET /v1/models parāda visus modeļus, to cenas un pieejamību. Atslēga nav nepieciešama.
  • POST /v1/files pieņem multipart augšupielādi ar lauku file un atgriež file_id, kas ir derīgs 24 stundas.
  • GET /v1/requests/:id atgriež iepriekšēju rezultātu. Pievienojiet ?format= ar jebkuru izvades formātu, lai to iegūtu citā formātā.
  • GET /v1/credits atgriež jūsu atlikumu un šīs atslēgas patēriņu.
  • POST /v1/keys/temporary atgriež pagaidu atslēgu ar 50 kredītiem. Bez reģistrācijas, viena dienā.

Izvades formāti

markdown

Viss dokuments kā Markdown. Tabulas ir GitHub formāta tabulas, formulas ir iekļautas $...$, un lappuses ir atdalītas ar <!-- page:N -->.

json

Vienāda struktūra no katra modeļa: lappuses, katra ar tipizētiem blokiem. Bloku tipi ir heading, paragraph, list, table, formula, image, header un footer. bbox, confidence un lappuses izmērs ir null, ja modelis tos nenodrošina, kas attiecas uz šobrīd aktīvajiem modeļiem.

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 atbilde un output objekts, kas satur failu: format, filename, mime_type, encoding un data. text, html un csv ir UTF-8 virknes (encoding: "utf8"); docx un xlsx ir base64 (encoding: "base64"). csv un xlsx satur tabulas (viena lapa katrai tabulai) vai teksta rindiņas, ja tabulu nav. txt tiek pieņemts kā teksta alternatīvais nosaukums.

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

Maršrutēšana un rezerves modeļi

Iestatiet model uz auto, un mēs izvēlēsimies modeli katram dokumentam. Izmantojiet route, lai norādītu prioritāti: cheapest, fastest vai quality.

Pievienojiet fallbacks, lai nodrošinātu darbību arī dīkstāvju laikā. Ja pirmais modelis atgriež kļūdu vai pārsniedz pieprasījumu limitu, tiek palaists nākamais. Atbilde parāda, kurš modelis atbildēja, un jūs maksājat tikai par to.

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

Kredīti

Katram modelim ir cena kredītos par lappusi. Par 1 $ var iegādāties 1,000 kredītus, un to derīguma termiņš nebeidzas. Katrā atbildē ir iekļauts usage.credits.

  • Neveiksmīgi un tukši rezultāti ir bez maksas.
  • Nosūtot to pašu failu tam pašam modelim atkārtoti, rezultāts tiek nodrošināts no kešatmiņas bez maksas.
  • Katrai API atslēgai var būt savs kredītu limits.

Kļūdas

400Pieprasījums ir nepareizi formatēts vai faila veids netiek atbalstīts.
401API atslēga trūkst vai ir atsaukta.
402Nepietiek kredītu vai atslēga ir sasniegusi savu kredītu limitu.
413Fails ir lielāks par šī modeļa atļauto robežu.
429Pārāk daudz pieprasījumu. Mēģiniet vēlreiz pēc laika, kas norādīts Retry-After galvenē.
502Visi modeļi rezerves ķēdē cieta neveiksmi. Maksa netiek iekasēta.
503Pieprasītais modelis vēl nav pievienots.

Aģenti, MCP un CLI

Programmēšanas aģenti var izmantot OCRRouter bez reģistrācijas soļa. CLI un MCP serveris pirmajā lietošanas reizē pieprasa pagaidu atslēgu ar 50 kredītiem un saglabā to ~/.ocrrouter/config.json. Iestatiet OCRROUTER_API_KEY, lai izmantotu savu atslēgu.

# CLI
npx ocrrouter invoice.pdf --format markdown

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

Šīs lapas mašīnlasāms kopsavilkums ir pieejams šeit: /llms.txt.

Jautājumi