OCRRouter

API دستاویزات

بنیادی تصورات کے لیے گائیڈز۔ ہر اینڈ پوائنٹ اور پیرامیٹر API ریفرنس میں موجود ہے۔

فوری آغاز

ایک API کلید بنائیں، پھر فائل بھیجیں۔ نئے اکاؤنٹس 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ماڈل ID جیسے mistral/mistral-ocr، یا auto۔
file_urlstringکسی PDF یا تصویر کا پبلک URL۔ file_url، file_base64 یا file_id میں سے کوئی ایک استعمال کریں۔
file_base64stringفائل بطور base64، 20 MB تک۔
file_idstringبڑی فائلوں کے لیے، POST /v1/files کی طرف سے واپس کی گئی ID۔
formatstringmarkdown (ڈیفالٹ)، json، text، html، csv، docx یا xlsx۔
pagesstringصفحات کی رینج، مثال کے طور پر 1-5,8۔ ڈیفالٹ تمام صفحات ہیں۔
fallbacksstring[]پہلا ماڈل فیل ہونے کی صورت میں، ترتیب سے آزمانے کے لیے ماڈل IDs۔
routestringماڈل auto کے ساتھ: quality (ڈیفالٹ)، cheapest یا fastest۔
filenamestringآپ کے سرگرمی لاگ میں دکھایا جانے والا اختیاری نام۔

دیگر اینڈ پوائنٹس:

  • GET /v1/models تمام ماڈلز، ان کی قیمت اور دستیابی کی فہرست دکھاتا ہے۔ کلید کی ضرورت نہیں۔
  • POST /v1/files ایک file فیلڈ کے ساتھ ملٹی پارٹ اپ لوڈ لیتا ہے اور file_id لوٹاتا ہے جو 24 گھنٹے تک کارآمد رہتا ہے۔
  • 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 یو ٹی ایف-8 اسٹرنگز ہیں (encoding: "utf8")؛ docx اور xlsx بیس64 ہیں (encoding: "base64")۔ csv اور xlsx میں ٹیبلز شامل ہوتے ہیں (فی ٹیبل ایک شیٹ)، یا ٹیبل نہ ہونے کی صورت میں ٹیکسٹ لائنز۔ txt کو 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}}

روٹنگ اور فال بیکس

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 شامل ہوتا ہے۔

  • ناکام اور خالی نتائج مفت ہیں۔
  • ایک ہی فائل کو دوبارہ اسی ماڈل پر بھیجنے پر کیشے (cache) سے مفت فراہم کیا جاتا ہے۔
  • ہر API کلید کی اپنی کریڈٹ حد ہو سکتی ہے۔

خرابیاں

400درخواست نامکمل ہے یا فائل فارمیٹ سپورٹڈ نہیں ہے۔
401API کلید غائب ہے یا منسوخ کر دی گئی ہے۔
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 پر دستیاب ہے۔

اکثر پوچھے جانے والے سوالات