OCRRouter

API sənədləri

Əsas anlayışlar üçün bələdçi. Bütün endpoint-lər və parametrlər API arayışındadır.

Quickstart

API açarı yaradın və fayl göndərin. Yeni hesablar 50 pulsuz kreditlə başlayır.

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

Sorğu

JSON gövdəsi və Authorization: Bearer başlığı ilə POST https://api.ocrrouter.ai/v1/ocr.

modelstringmistral/mistral-ocr kimi model ID-si və ya auto.
file_urlstringPDF və ya şəklin ictimai URL-i. file_url, file_base64 və ya file_id parametrlərindən birini istifadə edin.
file_base64stringBase64 formatında fayl, 20 MB-a qədər.
file_idstringDaha böyük fayllar üçün POST /v1/files tərəfindən qaytarılan ID.
formatstringmarkdown (standart), json, text, html, csv, docx və ya xlsx.
pagesstringSəhifə aralığı, məsələn 1-5,8. Standart olaraq bütün səhifələr.
fallbacksstring[]Birinci model uğursuz olduqda ardıcıllıqla yoxlanılacaq model ID-ləri.
routestringmodel auto olduqda: quality (standart), cheapest və ya fastest.
filenamestringFəaliyyət jurnalınızda göstərilən seçimli ad.

Digər endpoint-lər:

  • GET /v1/models bütün modelləri, onların qiymətini və aktiv olub-olmadığını sadalayır. Açar tələb olunmur.
  • POST /v1/files file sahəsi ilə multipart yükləmə qəbul edir və 24 saat keçərli olan file_id qaytarır.
  • GET /v1/requests/:id əvvəlki nəticəni qaytarır. Başqa formatda əldə etmək üçün istənilən çıxış formatı ilə ?format= əlavə edin.
  • GET /v1/credits balansınızı və bu açarın istifadəsini qaytarır.
  • POST /v1/keys/temporary 50 kreditli müvəqqəti açar qaytarır. Qeydiyyatsız, gündə bir dəfə.

Çıxış formatları

markdown

Markdown formatında bütöv sənəd. Cədvəllər GitHub formatlı cədvəllərdir, düsturlar $...$ içinə alınır və səhifələr <!-- page:N --> ilə ayrılır.

json

Hər modeldən eyni struktur: hər birində tipli bloklar olan səhifələr. Blok növləri: heading, paragraph, list, table, formula, image, header və footer. Model bunları təmin etmədikdə (hazırda aktiv olan modellərdə olduğu kimi) bbox, confidence və səhifə ölçüsü null olur.

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 cavabı və faylı saxlayan output obyekti: format, filename, mime_type, encoding və data. text, html və csv UTF-8 sətirləridir (encoding: "utf8"); docx və xlsx base64-dür (encoding: "base64"). csv və xlsx cədvəlləri (hər cədvəl üçün bir vərəq) və ya cədvəl olmadıqda mətn sətirlərini saxlayır. txt text üçün alternativ ad kimi qəbul edilir.

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

Yönləndirmə və ehtiyat modellər

model parametrini auto təyin edin və hər sənəd üçün modeli biz seçək. Nəyin vacib olduğunu bildirmək üçün route istifadə edin: cheapest, fastest və ya quality.

Kəsintilər zamanı fasiləsiz işləmək üçün fallbacks əlavə edin. Birinci model xəta verdikdə və ya limitə düşdükdə növbəti model işə düşür. Cavab sizə hansı modelin cavab verdiyini bildirir və yalnız həmin model üçün ödəniş edirsiniz.

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

Kreditlər

Hər modelin səhifə başına kreditlə qiyməti var. $1 sizə 1,000 kredit verir və onların müddəti bitmir. Hər cavaba usage.credits daxildir.

  • Uğursuz və boş nəticələr pulsuzdur.
  • Eyni faylı eyni modelə təkrar göndərmək keşdən pulsuz təmin edilir.
  • Hər API açarının öz kredit limiti ola bilər.

Xətalar

400Sorğu yanlış formalaşdırılıb və ya fayl növü dəstəklənmir.
401API açarı çatışmır və ya ləğv edilib.
402Kifayət qədər kredit yoxdur və ya açar kredit limitinə çatıb.
413Fayl bu model üçün nəzərdə tutulmuş limitdən böyükdür.
429Həddindən artıq sorğu. Retry-After başlığındakı müddətdən sonra yenidən cəhd edin.
502Ehtiyat zəncirindəki bütün modellər uğursuz oldu. Sizdən ödəniş tutulmur.
503Tələb etdiyiniz model hələ qoşulmayıb.

Agentlər, MCP və CLI

Kodlaşdırma agentləri OCRRouter xidmətindən qeydiyyatsız istifadə edə bilər. CLI və MCP serveri ilk istifadədə 50 kreditli müvəqqəti açar tələb edir və onu ~/.ocrrouter/config.json faylında saxlayır. Öz açarınızı istifadə etmək üçün OCRROUTER_API_KEY təyin edin.

# CLI
npx ocrrouter invoice.pdf --format markdown

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

Bu səhifənin maşın tərəfindən oxuna bilən xülasəsi buradadır: /llms.txt.

Suallar