OCRRouter

API ডকুমেন্টেশন

মূল বিষয়গুলোর নির্দেশিকা। প্রতিটি এন্ডপয়েন্ট এবং প্যারামিটার API রেফারেন্সে রয়েছে।

কুইকস্টার্ট

একটি 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 করুন।

modelstringএকটি মডেল আইডি যেমন mistral/mistral-ocr, অথবা auto।
file_urlstringPDF বা ছবির পাবলিক URL। file_url, file_base64 বা file_id-এর যেকোনো একটি ব্যবহার করুন।
file_base64stringbase64 হিসেবে ফাইল, সর্বোচ্চ ২০ MB পর্যন্ত।
file_idstringবড় ফাইলের ক্ষেত্রে POST /v1/files থেকে পাওয়া ID।
formatstringmarkdown (ডিফল্ট), json, text, html, csv, docx বা xlsx।
pagesstringপেজ রেঞ্জ, উদাহরণস্বরূপ 1-5,8। ডিফল্টভাবে সব পেজ।
fallbacksstring[]প্রথম মডেলটি ফেইল করলে ক্রমানুসারে চেষ্টা করার জন্য মডেল আইডিগুলো।
routestringauto মডেলের সাথে: quality (ডিফল্ট), cheapest বা fastest।
filenamestringঐচ্ছিক নাম যা আপনার অ্যাক্টিভিটি লগে দেখানো হবে।

অন্যান্য এন্ডপয়েন্ট:

  • GET /v1/models প্রতিটি মডেলের তালিকা, এর মূল্য এবং এটি অ্যাভেইলএবল কি না তা দেখায়। কোনো কী প্রয়োজন নেই।
  • POST /v1/files একটি file ফিল্ডসহ মাল্টিপার্ট আপলোড নেয় এবং একটি file_id রিটার্ন করে যা ২৪ ঘণ্টার জন্য কার্যকর থাকে।
  • GET /v1/requests/:id পূর্ববর্তী ফলাফল রিটার্ন করে। অন্য কোনো আউটপুট ফরম্যাটে পেতে ?format= যোগ করুন।
  • GET /v1/credits আপনার ব্যালেন্স এবং এই কী-এর ব্যবহার রিটার্ন করে।
  • POST /v1/keys/temporary 50টি ক্রেডিটসহ একটি অস্থায়ী কী রিটার্ন করে। সাইন-আপের প্রয়োজন নেই, দিনে একটি।

আউটপুট ফরম্যাট

markdown

পুরো ডকুমেন্টটি Markdown হিসেবে। টেবিলগুলো GitHub-flavoured টেবিল, ফর্মুলাগুলো $...$ দিয়ে র‍্যাপ করা এবং পেজগুলো <!-- page:N --> দিয়ে আলাদা করা।

json

প্রতিটি মডেল থেকে একই স্ট্রাকচার: পেজগুলো, প্রতিটিতে টাইপড ব্লক। ব্লকের ধরনগুলো হলো heading, paragraph, list, table, formula, image, header এবং footer। মডেল যখন এগুলো প্রদান করে না, তখন bbox, confidence এবং পেজের সাইজ null থাকে, যা বর্তমানে সক্রিয় মডেলগুলোর ক্ষেত্রে প্রযোজ্য।

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 রেসপন্সের সাথে একটি output অবজেক্ট যা ফাইল ধারণ করে: format, filename, mime_type, encoding এবং data। text, html এবং csv হলো UTF-8 স্ট্রিং (encoding: "utf8"); docx এবং xlsx হলো base64 (encoding: "base64")। csv এবং xlsx টেবিলগুলো ধারণ করে (প্রতি টেবিলে একটি শিট), অথবা কোনো টেবিল না থাকলে টেক্সট লাইনগুলো। text-এর বিকল্প নাম হিসেবে txt-ও গ্রহণযোগ্য।

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

রাউটিং ও ফলব্যাক

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,000 ক্রেডিট পাওয়া যায় এবং এগুলোর কোনো মেয়াদ শেষ হয় না। প্রতিটি রেসপন্সে usage.credits অন্তর্ভুক্ত থাকে।

  • ব্যর্থ এবং খালি ফলাফলের জন্য কোনো চার্জ কাটা হয় না।
  • একই ফাইল একই মডেলে পুনরায় পাঠালে ক্যাশ থেকে ফ্রিতে সার্ভিস দেওয়া হয়।
  • প্রতিটি API key-এর নিজস্ব ক্রেডিট লিমিট থাকতে পারে।

এরর সমূহ

400রিকোয়েস্টটি ত্রুটিপূর্ণ অথবা ফাইল টাইপ সমর্থিত নয়।
401API key পাওয়া যায়নি অথবা বাতিল করা হয়েছে।
402পর্যাপ্ত ক্রেডিট নেই, অথবা কী-এর ক্রেডিট লিমিট শেষ হয়ে গেছে।
413ফাইলটি এই মডেলের নির্দিষ্ট সীমার চেয়ে বড়।
429অতিরিক্ত রিকোয়েস্ট পাঠানো হয়েছে। Retry-After হেডারে উল্লেখিত সময়ের পর আবার চেষ্টা করুন।
502ফলব্যাক চেইনের প্রতিটি মডেলই ব্যর্থ হয়েছে। আপনার কোনো চার্জ কাটা হয়নি।
503আপনার অনুরোধ করা মডেলটি এখনো সংযুক্ত করা হয়নি।

এজেন্ট, MCP এবং CLI

কোডিং এজেন্টরা সাইন-আপ ছাড়াই OCRRouter ব্যবহার করতে পারে। CLI এবং MCP সার্ভার প্রথম ব্যবহারের সময় 50 ক্রেডিটসহ একটি অস্থায়ী কী চেয়ে নেয় এবং তা ~/.ocrrouter/config.json-এ সেভ করে। আপনার নিজস্ব কী ব্যবহার করতে OCRROUTER_API_KEY সেট করুন।

# CLI
npx ocrrouter invoice.pdf --format markdown

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

এই পেজের একটি মেশিন-রিডেবল সারাংশ /llms.txt-এ পাওয়া যাবে।

প্রশ্নোত্তর