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.
| model | string | ID model seperti mistral/mistral-ocr, atau auto. |
| file_url | string | URL awam untuk PDF atau imej. Gunakan salah satu daripada file_url, file_base64 atau file_id. |
| file_base64 | string | Fail dalam bentuk base64, sehingga 20 MB. |
| file_id | string | ID yang dikembalikan oleh POST /v1/files, untuk fail yang lebih besar. |
| format | string | markdown (lalai), json, text, html, csv, docx atau xlsx. |
| pages | string | Julat halaman, contohnya 1-5,8. Lalai kepada semua halaman. |
| fallbacks | string[] | Senarai ID model untuk dicuba, mengikut urutan, jika model pertama gagal. |
| route | string | Dengan model auto: quality (lalai), cheapest atau fastest. |
| filename | string | Nama pilihan yang dipaparkan dalam log aktiviti anda. |
Titik akhir lain:
GET /v1/modelsmenyenaraikan setiap model, harganya dan status ketersediaannya. Tiada kunci diperlukan.POST /v1/filesmenerima muat naik multipart dengan medanfiledan mengembalikanfile_idyang sah selama 24 jam.GET /v1/requests/:idmengembalikan hasil sebelum ini. Tambah?format=bersama mana-mana format output untuk mendapatkannya dalam format lain.GET /v1/creditsmengembalikan baki anda dan penggunaan kunci ini.POST /v1/keys/temporarymengembalikan 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.
{"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.
{"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
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 mcpRingkasan halaman ini yang boleh dibaca mesin terdapat di /llms.txt.