क्विकस्टार्ट
एक API key बनाएं, फिर एक फ़ाइल भेजें। नए खाते 50 मुफ़्त क्रेडिट के साथ शुरू होते हैं।
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"
}'अनुरोध
JSON बॉडी और Authorization: Bearer हेडर के साथ POST https://api.ocrrouter.ai/v1/ocr।
| model | string | एक मॉडल ID जैसे mistral/mistral-ocr, या auto। |
| file_url | string | PDF या छवि का सार्वजनिक URL। file_url, file_base64 या file_id में से किसी एक का उपयोग करें। |
| file_base64 | string | base64 के रूप में फ़ाइल, 20 MB तक। |
| file_id | string | बड़ी फ़ाइलों के लिए POST /v1/files द्वारा लौटाई गई ID। |
| format | string | markdown (डिफ़ॉल्ट), json, text, html, csv, docx या xlsx। |
| pages | string | पेज रेंज, उदाहरण के लिए 1-5,8। डिफ़ॉल्ट रूप से सभी पेज। |
| fallbacks | string[] | पहला मॉडल विफल होने पर क्रम से आज़माने के लिए मॉडल IDs। |
| route | string | model auto के साथ: quality (डिफ़ॉल्ट), cheapest या fastest। |
| filename | string | वैकल्पिक नाम जो आपके एक्टिविटी लॉग में दिखाई देगा। |
अन्य एंडपॉइंट्स:
GET /v1/modelsप्रत्येक मॉडल, उसकी कीमत और उसकी उपलब्धता की सूची देता है। किसी key की आवश्यकता नहीं है।POST /v1/filesfileफ़ील्ड के साथ एक मल्टीपार्ट अपलोड लेता है और एकfile_idलौटाता है जो 24 घंटे तक काम करता है।GET /v1/requests/:idपिछला परिणाम लौटाता है। इसे किसी अन्य फ़ॉर्मेट में पाने के लिए किसी भी आउटपुट फ़ॉर्मेट के साथ?format=जोड़ें।GET /v1/creditsआपका बैलेंस और इस key का उपयोग लौटाता है।POST /v1/keys/temporary50 क्रेडिट के साथ एक अस्थायी key लौटाता है। कोई साइन-अप नहीं, प्रतिदिन एक।
आउटपुट फ़ॉर्मेट
markdown
Markdown के रूप में पूरा दस्तावेज़। तालिकाएं GitHub-फ़्लेवर्ड टेबल हैं, सूत्र $...$ में लपेटे गए हैं, और पेज <!-- page:N --> द्वारा अलग किए गए हैं।
json
प्रत्येक मॉडल से समान संरचना: पेज, प्रत्येक में टाइप किए गए ब्लॉक। ब्लॉक के प्रकार heading, paragraph, list, table, formula, image, header और footer हैं। जब मॉडल उन्हें प्रदान नहीं करता है तो bbox, confidence और पेज का आकार null होते हैं, जैसा कि आज लाइव मॉडलों के मामले में है।
{"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 रिस्पॉन्स के साथ-साथ एक फ़ाइल रखने वाला output ऑब्जेक्ट: format, filename, mime_type, encoding और data। text, html और csv UTF-8 स्ट्रिंग्स (encoding: "utf8") हैं; docx और xlsx base64 (encoding: "base64") हैं। csv और xlsx तालिकाओं को (प्रति तालिका एक शीट) रखते हैं, या कोई तालिका न होने पर टेक्स्ट पंक्तियों को। text के दूसरे नाम के रूप में txt भी स्वीकार किया जाता है।
{"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}}रूटिंग और फ़ॉलबैक
model को auto पर सेट करें और हम प्रत्येक दस्तावेज़ के लिए एक मॉडल चुनेंगे। क्या मायने रखता है यह तय करने के लिए route का उपयोग करें: cheapest, fastest या quality।
आउटेज के दौरान भी काम जारी रखने के लिए fallbacks जोड़ें। यदि पहले मॉडल में त्रुटि आती है या रेट-लिमिट होती है, तो अगला मॉडल चलता है। रिस्पॉन्स आपको बताता है कि किस मॉडल ने उत्तर दिया, और आप केवल उसी के लिए भुगतान करते हैं।
{"model": "mistral/mistral-ocr","fallbacks": ["google/gemini-flash", "tesseract/tesseract"],"file_url": "https://example.com/report.pdf"}क्रेडिट
प्रत्येक मॉडल की कीमत प्रति पेज क्रेडिट में होती है। $1 में 1,000 क्रेडिट मिलते हैं और वे कभी समाप्त नहीं होते। प्रत्येक रिस्पॉन्स में usage.credits शामिल होता है।
- विफल और खाली परिणाम मुफ़्त हैं।
- उसी फ़ाइल को उसी मॉडल पर दोबारा भेजना कैश से मुफ़्त में पूरा किया जाता है।
- प्रत्येक API key की अपनी क्रेडिट सीमा हो सकती है।
त्रुटियां
एजेंट्स, MCP और CLI
कोडिंग एजेंट्स बिना साइन-अप चरण के OCRRouter का उपयोग कर सकते हैं। CLI और MCP सर्वर पहली बार उपयोग करने पर 50 क्रेडिट के साथ एक अस्थायी key मांगते हैं और इसे ~/.ocrrouter/config.json में सहेजते हैं। अपनी स्वयं की key का उपयोग करने के लिए OCRROUTER_API_KEY सेट करें।
# CLI
npx ocrrouter invoice.pdf --format markdown
# MCP server for Claude Code
claude mcp add ocrrouter -- npx ocrrouter mcpइस पेज का मशीन-पठनीय सारांश /llms.txt पर उपलब्ध है।