OCRRouter

API dokumentacija

Vodiči za glavne koncepte. Svaka krajnja točka i parametar nalaze se u API referenci.

Brzi početak

Izradite API ključ, a zatim pošaljite datoteku. Novi računi počinju s 50 besplatnih kredita.

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

Zahtjev

POST https://api.ocrrouter.ai/v1/ocr uz JSON tijelo zahtjeva i zaglavlje Authorization: Bearer.

modelstringID modela kao što je mistral/mistral-ocr, ili auto.
file_urlstringJavni URL PDF-a ili slike. Upotrijebite jedno od: file_url, file_base64 ili file_id.
file_base64stringDatoteka u base64 formatu, do 20 MB.
file_idstringID koji vraća POST /v1/files, za veće datoteke.
formatstringmarkdown (zadano), json, text, html, csv, docx ili xlsx.
pagesstringRaspon stranica, npr. 1-5,8. Zadano su sve stranice.
fallbacksstring[]ID-jevi modela koje treba isprobati redom ako prvi model zakaže.
routestringUz model auto: quality (zadano), cheapest ili fastest.
filenamestringNeobavezni naziv prikazan u vašem dnevniku aktivnosti.

Ostale krajnje točke:

  • GET /v1/models prikazuje popis svih modela, njihove cijene i dostupnost. Ključ nije potreban.
  • POST /v1/files prima multipart prijenos s poljem file i vraća file_id koji vrijedi 24 sata.
  • GET /v1/requests/:id vraća raniji rezultat. Dodajte ?format= s bilo kojim izlaznim formatom kako biste ga dobili u drugom obliku.
  • GET /v1/credits vraća stanje vašeg računa i potrošnju ovog ključa.
  • POST /v1/keys/temporary vraća privremeni ključ s 50 kredita. Bez registracije, jedan po danu.

Izlazni formati

markdown

Cijeli dokument u obliku Markdowna. Tablice su u GitHub formatu, formule su unutar $...$, a stranice su razdvojene s <!-- page:N -->.

json

Ista struktura za svaki model: stranice, svaka s tipiziranim blokovima. Tipovi blokova su heading, paragraph, list, table, formula, image, header i footer. Vrijednosti bbox, confidence i veličina stranice su null kada ih model ne pruža, što je slučaj s modelima koji su trenutno dostupni.

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 odgovor uz objekt output koji sadrži datoteku: format, filename, mime_type, encoding i data. text, html i csv su UTF-8 tekstualni nizovi (encoding: "utf8"); docx i xlsx su base64 (encoding: "base64"). csv i xlsx sadrže tablice (jedan list po tablici) ili retke teksta ako nema tablica. txt je prihvaćen kao alternativni naziv za 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}}

Usmjeravanje i zamjenski modeli

Postavite model na auto i mi ćemo odabrati model za svaki dokument. Koristite route kako biste odredili kriterij: cheapest, fastest ili quality.

Dodajte fallbacks kako biste osigurali neprekidan rad tijekom ispada. Ako prvi model javi pogrešku ili dosegne ograničenje broja zahtjeva, pokreće se sljedeći. Odgovor navodi koji je model odgovorio i plaćate samo taj model.

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

Krediti

Svaki model ima cijenu u kreditima po stranici. $1 donosi 1,000 kredita i oni nikada ne istječu. Svaki odgovor uključuje usage.credits.

  • Neuspjeli i prazni rezultati se ne naplaćuju.
  • Ponovno slanje iste datoteke istom modelu poslužuje se iz predmemorije besplatno.
  • Svaki API ključ može imati vlastiti limit kredita.

Pogreške

400Zahtjev je neispravan ili vrsta datoteke nije podržana.
401API ključ nedostaje ili je opozvan.
402Nedovoljno kredita ili je ključ dosegao limit kredita.
413Datoteka je veća od ograničenja za ovaj model.
429Previše zahtjeva. Pokušajte ponovno nakon vremena navedenog u zaglavlju Retry-After.
502Svaki model u nizu zamjenskih modela je zakazao. Ne naplaćuje vam se ništa.
503Zatraženi model još nije povezan.

Agenti, MCP i CLI

Agenti za programiranje mogu koristiti OCRRouter bez postupka registracije. CLI i MCP poslužitelj pri prvoj upotrebi traže privremeni ključ s 50 kredita i spremaju ga u ~/.ocrrouter/config.json. Postavite OCRROUTER_API_KEY za korištenje vlastitog ključa.

# CLI
npx ocrrouter invoice.pdf --format markdown

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

Strojno čitljiv sažetak ove stranice dostupan je na /llms.txt.

Pitanja