OCRRouter

Dokumentasi API

Panduan untuk konsep utama. Setiap titik akhir dan parameter disediakan dalam rujukan API.

Mula pantas

Cipta kunci API, kemudian hantar fail. Akaun baharu bermula dengan 50 kredit percuma.

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

Permintaan

POST https://api.ocrrouter.ai/v1/ocr dengan badan JSON dan pengepala Authorization: Bearer.

modelstringID model seperti mistral/mistral-ocr, atau auto.
file_urlstringURL awam untuk PDF atau imej. Gunakan salah satu daripada file_url, file_base64 atau file_id.
file_base64stringFail dalam bentuk base64, sehingga 20 MB.
file_idstringID yang dikembalikan oleh POST /v1/files, untuk fail yang lebih besar.
formatstringmarkdown (lalai), json, text, html, csv, docx atau xlsx.
pagesstringJulat halaman, contohnya 1-5,8. Lalai kepada semua halaman.
fallbacksstring[]Senarai ID model untuk dicuba, mengikut urutan, jika model pertama gagal.
routestringDengan model auto: quality (lalai), cheapest atau fastest.
filenamestringNama pilihan yang dipaparkan dalam log aktiviti anda.

Titik akhir lain:

  • GET /v1/models menyenaraikan setiap model, harganya dan status ketersediaannya. Tiada kunci diperlukan.
  • POST /v1/files menerima muat naik multipart dengan medan file dan mengembalikan file_id yang sah selama 24 jam.
  • GET /v1/requests/:id mengembalikan hasil sebelum ini. Tambah ?format= bersama mana-mana format output untuk mendapatkannya dalam format lain.
  • GET /v1/credits mengembalikan baki anda dan penggunaan kunci ini.
  • POST /v1/keys/temporary mengembalikan kunci sementara dengan 50 kredit. Tanpa pendaftaran, satu setiap hari.

Format output

markdown

Keseluruhan dokumen sebagai Markdown. Jadual menggunakan format GitHub-flavored tables, formula diapit dengan $...$, dan halaman dipisahkan oleh <!-- page:N -->.

json

Struktur yang sama daripada setiap model: halaman, masing-masing dengan blok bertaip. Jenis blok ialah heading, paragraph, list, table, formula, image, header dan footer. bbox, confidence dan saiz halaman adalah null apabila model tidak menyediakannya, seperti kebanyakan model yang aktif hari ini.

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

Respons Markdown berserta objek output yang mengandungi fail: format, filename, mime_type, encoding dan data. text, html dan csv adalah rentetan UTF-8 (encoding: "utf8"); docx dan xlsx adalah base64 (encoding: "base64"). csv dan xlsx mengandungi jadual (satu helaian setiap jadual), atau baris teks jika tiada jadual. txt diterima sebagai nama lain untuk 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}}

Penghalaan dan sandaran

Tetapkan model kepada auto dan kami akan memilih model yang sesuai bagi setiap dokumen. Gunakan route untuk menyatakan keutamaan anda: cheapest, fastest atau quality.

Tambah fallbacks untuk mengelakkan gangguan perkhidmatan. Jika model pertama ralat atau dihadkan kadar permintaannya, model seterusnya akan dijalankan. Respons akan menyatakan model mana yang menjawab, dan anda hanya membayar untuk model tersebut.

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

Kredit

Setiap model mempunyai harga dalam kredit bagi setiap halaman. $1 membeli 1,000 kredit dan ia tidak mempunyai tarikh luput. Setiap respons menyertakan usage.credits.

  • Hasil yang gagal dan kosong adalah percuma.
  • Menghantar fail yang sama ke model yang sama sekali lagi akan diambil daripada cache secara percuma.
  • Setiap kunci API boleh mempunyai had kreditnya sendiri.

Ralat

400Permintaan tidak sah atau jenis fail tidak disokong.
401Kunci API tiada atau telah dibatalkan.
402Kredit tidak mencukupi, atau kunci telah mencapai had kreditnya.
413Saiz fail melebihi had bagi model ini.
429Terlalu banyak permintaan. Cuba lagi selepas masa yang dinyatakan dalam pengepala Retry-After.
502Semua model dalam rantaian sandaran gagal. Anda tidak dikenakan bayaran.
503Model yang anda minta belum disambungkan lagi.

Ejen, MCP dan CLI

Ejen pengekodan boleh menggunakan OCRRouter tanpa langkah pendaftaran. CLI dan pelayan MCP akan meminta kunci sementara dengan 50 kredit pada penggunaan pertama dan menyimpannya dalam ~/.ocrrouter/config.json. Tetapkan OCRROUTER_API_KEY untuk menggunakan kunci anda sendiri.

# CLI
npx ocrrouter invoice.pdf --format markdown

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

Ringkasan halaman ini yang boleh dibaca mesin terdapat di /llms.txt.

Soalan