WaterMeter AI
TilO‘zbekcha
Boshqa tillar

Suv o'lchagich OCR API

Suv o'lchagich OCR API. Bu sahifa uchinchi tomon tizimlari integratsiyasi uchun sayt serveri taqdim etadigan ochiq HTTP API-ni tushuntiradi.

Haqiqiy yuklash bilan boshlang

Avval ro'yxatdan o'ting, ish joyiga o'zingizning suv o'lchagich suratingizni yuklang va integratsiyaga tayyor bo'lganingizda API kalitini yarating.

Ro'yxatdan o'ting va surat yuklangAPI kalitini yarating

Umumiy ma'lumot

  • Barcha tashqi integratsiyalar uchun veb-sayt backendidan foydalaning.
  • Uchinchi tomon dasturlaridan waterMeterAi xizmatini to'g'ridan-to'g'ri ishlatmang.
  • Ochiq API veb-portal bilan bir xil foydalanuvchilar, kvota, kesh, vazifalar va audit qoidalariga ega.
  • Backend turli pastki yo AI bizneslarni joylashtirish konfiguratsiyasi orqali nishonga olishi mumkin.
  • Vazifa javoblari endi umumiy result_summary obyektini o'z ichiga oladi, shunda turli bizneslar turli natija turlarini ko'rsatishi mumkin.

Autentifikatsiya

  • Veb-saytga kiring va API Keys sahifasida API kalitini yarating.
  • To'liq API kaliti yaratilganda faqat bir marta ko'rsatiladi.
  • Har bir so'rovda kalitni Authorization sarlavhasida yuboring.
Authorization: Bearer wm_xxxxxxxxxxxxxxxxx

API Key Permissions and Limits

  • Each API key can have independent scopes, an IPv4/IPv6/CIDR allowlist, a total requests-per-minute limit, and a task submissions-per-minute limit.
  • A valid key without the required scope or outside its source IP allowlist returns 403.
  • Every valid-key request consumes the total request limit, including requests rejected by scope, IP, or submission policy.
  • Batch requests consume one total request unit and one submission unit per uploaded file.
  • Rate-limited responses return 429 with Retry-After and both X-RateLimit-* and X-SubmissionLimit-* headers.
  • Task creation also has a per-key concurrency limit and returns X-ConcurrencyLimit-* headers; a concurrency rejection uses 429.
  • For batch concurrency, only files that pass image validation reserve slots, and success headers report the actual active slots after task binding.
Retry-After: 30
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 59
X-RateLimit-Reset: 1785902400
X-SubmissionLimit-Limit: 10
X-SubmissionLimit-Remaining: 9
X-ConcurrencyLimit-Limit: 3
X-ConcurrencyLimit-Active: 1
X-ConcurrencyLimit-Remaining: 2

Yuklash qoidalari

  • Maksimal fayl hajmi: har bir rasm uchun 20MB.
  • Qo'llab-quvvatlanadigan formatlar: JPEG, PNG, WEBP.
  • Backend faqat fayl kengaytmasini emas, balki haqiqiy fayl mazmunini tasdiqlaydi.

Yuklash hajmini nazorat qilish

  • Paketli yuklamalar standart bo'yicha 8 tagacha rasmni qabul qiladi, har bir tasvir uchun 20MB va jami 20MB fayl kontenti cheklovi mavjud.
  • Agar fayl yoki partiya o'z chegarasidan oshsa, tasvirni tekshirish yoki vazifa yaratishdan 413 oldin qaytadi; Qisman partiya yaratilmaydi.
  • Backend Content-Length yo'q bo'lsa yoki chunked transfer ishlatilganda ham haqiqiy qabul qilingan bayt sonini ta'minlaydi.

Vazifa holatlari

  • queued: qabul qilindi va AI tomonidan qayta ishlanishini kutmoqda.
  • running: hozir qayta ishlanmoqda yoki dispetcherga topshirilgan va yakuniy natija uchun holat hali ham davriy tekshirilmoqda.
  • batch_waiting_ai: to'plamdagi har bir element AI xizmatining qayta onlayn bo'lishini kutmoqda.
  • batch_running: vazifalar to'plami dispetcherga topshirilgan va hali ham qayta ishlanmoqda.
  • done: muvaffaqiyatli yakunlandi.
  • failed: qayta ishlash muvaffaqiyatsiz bo'ldi.
  • waiting_ai: AI xizmati qayta ishga tushguncha navbatda turiladi, so'ng u avtomatik ravishda davom etadi.

Natija manbalari

  • fresh: AI tomonidan yangidan tanib olish natijasida yaratildi.
  • cached_exact: hozirgi AI versiya keshiga mos keldi.
  • cached_stale: AI oflayn, so'nggi keshlangan natija qaytarildi.
  • pending: hali yakuniy natija yo'q.
  • failed: vazifa muvaffaqiyatsiz bo'ldi.
  • Agar vazifa hali tugamagan bo'lsa, error_message so'nggi qayta urinish yoki kutish sababini tekshiring.

Kvota va hisob-kitob

  • Integratsiyangiz kvota yetishmasligi xatosidan qochishi kerak bo'lsa, ko'p vazifa yuborishdan oldin `GET /api/open/quota` dan foydalaning.
  • Faqat `fresh` manbali yangi AI tanib olishi kvotani sarflaydi.
  • `cached_exact`, `cached_stale`, `pending` va `failed` natijalari kvotani sarflamaydi.
  • Bepul hisoblar avval kunlik kvotadan foydalanadi. To'lovli hisoblar faol davriy kvota paketlaridan foydalanadi, so'ngra backend siyosatiga muvofiq vaqtinchalik yoki belgilangan kvotadan foydalanadi.
  • Kvota tugagach, vazifa topshirilishi `429` qaytaradi va yangi vazifa yaratish o'rniga xato xabarini kiritadi.

Kesh va natijaning yangiligi

  • Backend muvaffaqiyatli natijalarni rasm xeshi va AI versiyasi bo'yicha keshlaydi hamda quyi xizmatning namespace qiymatini ham hisobga oladi.
  • `cached_exact` shu tasvir hozirgi AI versiyasi uchun allaqachon muvaffaqiyatli natijaga ega bo'lganini anglatadi, shuning uchun yangi AI ishga tushirish talab qilinmagan.
  • `cached_stale` shuni anglatadiki, AI xizmati oflayn va backend eng so'nggi mavjud tarixiy natijani qaytaradi.
  • Agar `is_latest_ai_version` false bo'lsa, natijani foydalanish mumkin bo'lgan, ammo tekshirilishi kerak bo'lgan tarixiy ma'lumot sifatida saqlang.
  • Har bir `done` vazifa kvotani sarflagan deb hisoblamang; `result_source` qiymatini tekshiring.

Task completion webhooks

  • Send signed task completion events to your HTTPS endpoint with automatic retries.
  • This API key is inactive. Existing records remain available, but new, enabled, test, and secret-rotation operations are blocked.
X-WaterMeter-Webhook-Id: whev_new_event
X-WaterMeter-Webhook-Replay-Of: whev_original_event
replay_of_event_id: whev_original_event
blocked endpoint management: HTTP 409
canceled delivery status: canceled

GET/api/open/quota

Joriy kvota va qolgan foydalanishni o'qing.

So'rov namunasi
curl -X GET "https://watermeterai.com/api/open/quota" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Javob misoli
{
  "ok": true,
  "email": "[email protected]",
  "quota": {
    "account_type": "free",
    "daily_limit": 20,
    "used": 3,
    "remaining": 17,
    "day_tag": "2026-06-01",
    "is_unlimited": false,
    "monthly_remaining": 0,
    "monthly_bonus_remaining": 0,
    "fixed_remaining": 0,
    "nearest_expire_at": null,
    "quota_summary_text": "Free daily quota: 3/20 used today. Remaining: 17."
  }
}

GET/api/open/ai-status

Vazifalarni topshirish va keshlangan natijalar zaxirasi uchun jamoat xizmati holatini o'qing.

So'rov namunasi
curl -X GET "https://watermeterai.com/api/open/ai-status" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Javob misoli
{
  "ok": true,
  "is_online": true,
  "busy": false,
  "active_jobs": 0,
  "public_status": "online",
  "public_status_label": "online",
  "public_status_reason": "ready",
  "accepts_new_tasks": true,
  "can_return_cached_result": true,
  "queue_state": "idle",
  "queue_count": 0,
  "current_ai_version": "water_v2:wm-ai-v2-2026-06-01",
  "last_checked_at": "2026-06-01T06:15:30Z"
}

POST/api/open/tasks

Bitta rasmni yuklab, bitta vazifa yarating.

So'rov namunasi
curl -X POST "https://watermeterai.com/api/open/tasks" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx" \
  -F "file=@D:\data\meter_001.jpg"
Javob misoli
{
  "ok": true,
  "task_id": "8e6c4d1f8f8348c0bc53e2e39d2dc111",
  "status": "queued",
  "result_source": "pending",
  "visibility": "private",
  "ai_online": true,
  "is_latest_ai_version": false,
  "final_reading": "-",
  "result_summary": {
    "resultKind": "unknown",
    "primaryLabel": "Result",
    "primaryValue": "-",
    "secondaryLabel": "Detail",
    "secondaryValue": "-",
    "summaryText": "No result is available yet."
  },
  "error_message": "",
  "created_at": "2026-06-01T06:16:10Z"
}

GET/api/open/tasks/{task_id}

Bir vazifa holatini va yakuniy o'qishni o'qing.

So'rov namunasi
curl -X GET "https://watermeterai.com/api/open/tasks/task_a" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Javob misoli
{
  "ok": true,
  "task_id": "8e6c4d1f8f8348c0bc53e2e39d2dc111",
  "status": "done",
  "result_source": "fresh",
  "ai_online": true,
  "is_latest_ai_version": true,
  "final_reading": "123.45",
  "meter_type": "pointer",
  "success": "yes",
  "result_summary": {
    "resultKind": "water_meter",
    "primaryLabel": "Final Reading",
    "primaryValue": "123.45",
    "secondaryLabel": "Meter Type",
    "secondaryValue": "pointer",
    "summaryText": "Water meter recognition finished."
  },
  "error_message": "",
  "created_at": "2026-06-01T06:16:10Z"
}

GET/api/open/tasks

Joriy API kaliti egasining so'nggi vazifalarini o'qing.

So'rov namunasi
curl -X GET "https://watermeterai.com/api/open/tasks?limit=20" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Javob misoli
{
  "ok": true,
  "items": [
    {
      "task_id": "8e6c4d1f8f8348c0bc53e2e39d2dc111",
      "status": "done",
      "result_source": "cached_exact",
      "final_reading": "123.45",
      "meter_type": "pointer",
      "success": "yes",
      "result_summary": {},
      "ai_online": true,
      "is_latest_ai_version": true,
      "created_at": "2026-06-01T06:16:10Z",
      "error_message": ""
    }
  ]
}

POST/api/open/batches

Bir so'rovda bir nechta rasmlarni yuklang.

So'rov namunasi
curl -X POST "https://watermeterai.com/api/open/batches" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx" \
  -F "files=@D:\data\meter_001.jpg" \
  -F "files=@D:\data\meter_002.jpg"
Javob misoli
{
  "ok": true,
  "batch_id": "5a14f4e5f6d34fdabce00e62c0dd0001",
  "status": "batch_running",
  "total_count": 2,
  "done_count": 0,
  "failed_count": 0,
  "pending_count": 2,
  "items": [
    {
      "index": 0,
      "file_name": "meter_001.jpg",
      "task_id": "task_a",
      "status": "queued",
      "result_source": "pending",
      "final_reading": "-",
      "failure_kind": "",
      "error_message": ""
    },
    {
      "index": 1,
      "file_name": "meter_002.jpg",
      "task_id": "task_b",
      "status": "queued",
      "result_source": "pending",
      "final_reading": "-",
      "failure_kind": "",
      "error_message": ""
    }
  ]
}

GET/api/open/batches/{batch_id}

Partiyaning rivojlanishi va fayl bo'yicha vazifa holatlarini o'qing.

So'rov namunasi
curl -X GET "https://watermeterai.com/api/open/batches/5a14f4e5f6d34fdabce00e62c0dd0001" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Javob misoli
{
  "ok": true,
  "batch_id": "5a14f4e5f6d34fdabce00e62c0dd0001",
  "status": "batch_done",
  "total_count": 2,
  "done_count": 2,
  "failed_count": 0,
  "pending_count": 0,
  "items": [
    {
      "index": 0,
      "file_name": "meter_001.jpg",
      "task_id": "task_a",
      "status": "done",
      "result_source": "fresh",
      "final_reading": "123.45",
      "failure_kind": "",
      "error_message": ""
    },
    {
      "index": 1,
      "file_name": "meter_002.jpg",
      "task_id": "task_b",
      "status": "done",
      "result_source": "cached_exact",
      "final_reading": "456.78",
      "failure_kind": "",
      "error_message": ""
    }
  ]
}

Tavsiya etilgan oqim

  • Katta yuk yuborishdan oldin `GET /api/open/ai-status` tekshiring.
  • `task_id` yoki `batch_id` fayllarni topshirilgandan so'ng darhol o'z tizimingizda saqlang.
  • `queued`, `running`, `waiting_ai`, `batch_waiting_ai` va `batch_running` ni yakuniy bo'lmagan holatlar deb hisoblang va holatni davriy tekshirishda davom eting.
  • Tarmoq yo'li backendga yuqori kechikishga ega bo'lsa va joylashtirilgan biznes batch rejimini qo'llab-quvvatlaganda batch so'rovlaridan foydalaning.
  • Hozirda partiyaviy so'rovlar `webBackend -> dispatchCenter -> waterMeterAi` zanjiri orqali o'tadi.
  • `batch_waiting_ai` har bir element hali ham AI xizmatini kutmoqda, hali faol ishlamayapti.
  • Joriy etilgan biznes `CAD`bo'lsa, hozircha `POST /api/open/tasks` ishlating va batch upload'ni mavjud emas deb hisoblang.

Xatolik izohlari

  • 400: noto'g'ri so'rov yoki joylashtirilgan biznes batch yuklashni qo'llab-quvvatlamaydi.
  • 401: yo'qolgan, yaroqsiz, muddati o'tgan yoki o'chirilgan API kalit.
  • 403: the user account is not active, the key lacks the required scope, or the source IP is outside the key allowlist.
  • 404: vazifa yoki partiya topilmadi yoki hozirgi foydalanuvchiga tegishli emas.
  • 413: fayl juda katta.
  • 415: qo'llab-quvvatlanmagan tasvir turi yoki noto'g'ri tasvir mazmuni.
  • 429: quota exhausted or the API key request, submission, or concurrency limit was exceeded.
400 partiyaviy yuklash mavjud emas
{
  "detail": "batch upload is not supported for business: cax"
}
401 kalit yo'qolgan yoki noto'g'ri API
{
  "ok": false,
  "error": "unauthorized",
  "message": "Missing or invalid API key."
}
413 fayl juda katta
{
  "ok": false,
  "error": "file_too_large",
  "message": "Maximum file size is 20MB."
}
429 kvota tugadi
{
  "ok": false,
  "error": "quota_exhausted",
  "message": "Quota exhausted.",
  "quota": {
    "remaining": 0,
    "quota_summary_text": "Free daily quota: 20/20 used today. Remaining: 0."
  }
}

Ish jarayonini sinashga tayyormisiz?

Birinchi surat uchun veb ish maydonidan foydalaning, natija formati tizimingizga mos kelganda API kalitlariga o'ting.

Ro'yxatdan o'ting va surat yuklangAPI kalitini yarating