OCRRouter

API-dokumentation

Guider för grundkoncepten. Alla slutpunkter och parametrar finns i API-referensen.

Snabbstart

Skapa en API-nyckel och skicka sedan en fil. Nya konton startar med 50 gratis krediter.

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

Anrop

POST https://api.ocrrouter.ai/v1/ocr med en JSON-body och en Authorization: Bearer-header.

modelstringEtt modell-ID som mistral/mistral-ocr, eller auto.
file_urlstringPublik URL till en PDF eller bild. Använd en av file_url, file_base64 eller file_id.
file_base64stringFilen som base64, upp till 20 MB.
file_idstringID som returneras av POST /v1/files, för större filer.
formatstringmarkdown (standard), json, text, html, csv, docx eller xlsx.
pagesstringSidintervall, till exempel 1-5,8. Standard är alla sidor.
fallbacksstring[]Modell-ID:n att prova i tur och ordning om den första modellen misslyckas.
routestringMed modellen auto: quality (standard), cheapest eller fastest.
filenamestringValfritt namn som visas i din aktivitetslogg.

Andra slutpunkter:

  • GET /v1/models listar alla modeller, deras priser och om de är tillgängliga. Ingen nyckel krävs.
  • POST /v1/files tar emot en multipart-uppladdning med fältet file och returnerar ett file_id som är giltigt i 24 timmar.
  • GET /v1/requests/:id hämtar ett tidigare resultat. Lägg till ?format= med valfritt utdataformat för att få det i ett annat format.
  • GET /v1/credits returnerar ditt saldo och denna nyckels förbrukning.
  • POST /v1/keys/temporary returnerar en temporär nyckel med 50 krediter. Ingen registrering krävs, en per dag.

Utdataformat

markdown

Hela dokumentet som Markdown. Tabeller formateras som GitHub-flavored tables, formler omsluts av $...$ och sidor separeras med <!-- page:N -->.

json

Samma struktur från alla modeller: sidor, var och en med typade block. Blocktyper är heading, paragraph, list, table, formula, image, header och footer. bbox, confidence och sidstorlek är null när modellen inte tillhandahåller dem, vilket är fallet för modellerna som är aktiva idag.

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-svaret plus ett output-objekt som innehåller en fil: format, filename, mime_type, encoding och data. text, html och csv är UTF-8-strängar (encoding: "utf8"); docx och xlsx är base64 (encoding: "base64"). csv och xlsx innehåller tabellerna (ett blad per tabell), eller textraderna om det inte finns några. txt accepteras som ett alternativt namn för 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}}

Routning och fallbacks

Sätt model till auto så väljer vi en modell för varje dokument. Använd route för att ange vad som prioriteras: cheapest, fastest eller quality.

Lägg till fallbacks för att hantera driftstörningar sömlöst. Om den första modellen returnerar ett fel eller hastighetsbegränsas körs nästa. Svaret anger vilken modell som svarade, och du betalar bara för den.

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

Krediter

Varje modell har ett pris i krediter per sida. $1 ger 1,000 krediter och de förfaller aldrig. Varje svar innehåller usage.credits.

  • Misslyckade och tomma resultat är gratis.
  • Om du skickar samma fil till samma modell igen levereras resultatet gratis från cachen.
  • Varje API-nyckel kan ha en egen kreditgräns.

Fel

400Förfrågan är felaktigt formulerad eller så stöds inte filtypen.
401API-nyckeln saknas eller har återkallats.
402Inte tillräckligt med krediter, eller så har nyckeln nått sin kreditgräns.
413Filen är större än gränsen för denna modell.
429För många förfrågningar. Försök igen efter tiden som anges i Retry-After-headern.
502Alla modeller i fallback-kedjan misslyckades. Du debiteras inte.
503Modellen du efterfrågade är inte ansluten ännu.

Agenter, MCP och CLI

Kodagenter kan använda OCRRouter utan något registreringssteg. CLI-verktyget och MCP-servern ber om en temporär nyckel med 50 krediter vid första användningen och sparar den i ~/.ocrrouter/config.json. Sätt OCRROUTER_API_KEY för att använda din egen nyckel.

# CLI
npx ocrrouter invoice.pdf --format markdown

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

En maskinläsbar sammanfattning av denna sida finns på /llms.txt.

Frågor och svar