OCRRouter

API-dokumentation

Vejledninger til de vigtigste koncepter. Find alle endpoints og parametre i API-referencen.

Kom hurtigt i gang

Opret en API-nøgle, og send en fil. Nye konti starter med 50 gratis kreditter.

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

Anmodning

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

modelstringEt model-ID som f.eks. mistral/mistral-ocr eller auto.
file_urlstringOffentlig URL til en PDF eller et billede. Brug enten file_url, file_base64 eller file_id.
file_base64stringFilen som base64, op til 20 MB.
file_idstringID returneret af POST /v1/files til større filer.
formatstringmarkdown (standard), json, text, html, csv, docx eller xlsx.
pagesstringSideinterval, f.eks. 1-5,8. Standarden er alle sider.
fallbacksstring[]Model-ID'er, der prøves i rækkefølge, hvis den første model fejler.
routestringMed model auto: quality (standard), cheapest eller fastest.
filenamestringValgfrit navn, der vises i din aktivitetslog.

Andre endpoints:

  • GET /v1/models lister alle modeller, deres priser og om de er tilgængelige. Kræver ingen nøgle.
  • POST /v1/files modtager et multipart-upload med et file-felt og returnerer et file_id, der er gyldigt i 24 timer.
  • GET /v1/requests/:id henter et tidligere resultat. Tilføj ?format= med et vilkårligt outputformat for at hente det i et andet format.
  • GET /v1/credits viser din saldo og denne nøgles forbrug.
  • POST /v1/keys/temporary returnerer en midlertidig nøgle med 50 kreditter. Ingen oprettelse nødvendig, én per dag.

Outputformater

markdown

Hele dokumentet som Markdown. Tabeller er GitHub-flavored tabeller, formler er omsluttet af $...$, og sider adskilles med <!-- page:N -->.

json

Samme struktur fra alle modeller: sider, hver med typede blokke. Bloktyperne er heading, paragraph, list, table, formula, image, header og footer. bbox, confidence og sidestørrelse er null, hvis modellen ikke leverer dem, hvilket gælder for de modeller, der er aktive i dag.

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 et output-objekt, der indeholder en fil: format, filename, mime_type, encoding og data. text, html og csv er UTF-8-strenge (encoding: "utf8"); docx og xlsx er base64 (encoding: "base64"). csv og xlsx indeholder tabellerne (ét ark pr. tabel) eller tekstlinjerne, hvis der ingen tabeller er. txt accepteres som et synonym for 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}}

Routing og fallbacks

Sæt model til auto, så vælger vi en model for hvert dokument. Brug route til at angive, hvad der prioriteres: cheapest, fastest eller quality.

Tilføj fallbacks for at undgå nedbrud. Hvis den første model fejler eller rammer rate limits, kører den næste. Svaret fortæller, hvilken model der svarede, og du betaler kun for den.

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

Kreditter

Hver model har en pris i kreditter pr. side. $1 giver 1,000 kreditter, og de udløber ikke. Alle svar indeholder usage.credits.

  • Mislykkede og tomme resultater koster ingenting.
  • Hvis du sender den samme fil til den samme model igen, hentes den gratis fra cachen.
  • Hver API-nøgle kan have sin egen kreditgrænse.

Fejl

400Anmodningen er ugyldig, eller filtypen understøttes ikke.
401API-nøglen mangler eller er blevet tilbagekaldt.
402Ikke nok kreditter, eller nøglen har nået sin kreditgrænse.
413Filen er større end grænsen for denne model.
429For mange anmodninger. Prøv igen efter tidsrummet angivet i Retry-After-headeren.
502Alle modeller i fallback-kæden fejlede. Du bliver ikke opkrævet.
503Den ønskede model er endnu ikke tilsluttet.

Agenter, MCP og CLI

Kodningsagenter kan bruge OCRRouter uden at oprette en bruger. CLI'et og MCP-serveren anmoder om en midlertidig nøgle med 50 kreditter ved første brug og gemmer den i ~/.ocrrouter/config.json. Sæt OCRROUTER_API_KEY for at bruge din egen nøgle.

# CLI
npx ocrrouter invoice.pdf --format markdown

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

En maskinlæsbar oversigt over denne side findes på /llms.txt.

Spørgsmål