WaterMeter AI
KalbaLietuvių
Kitos kalbos

Vandens skaitiklis OCR API

Vandens skaitiklis OCR API. Šiame puslapyje dokumentuojama vieša HTTP API , kurią atskleidė svetainės vidinė dalis trečiųjų šalių integracijoms.

Pradėkite nuo tikro įkėlimo

Pirmiausia užsiregistruokite, įkelkite savo vandens skaitiklio nuotrauką darbo erdvėje, o tada, kai būsite pasiruošę integruoti, sukurkite API raktą.

Registruokitės ir įkelkite nuotraukąSukurkite API raktą

Apžvalga

  • Naudokite svetainės vidinę dalį visoms išorinėms integracijoms.
  • Nekvieskite waterMeterAi tiesiogiai iš trečiųjų šalių programų.
  • Atviras API dalijasi tais pačiais vartotojais, kvota, talpykla, užduotimis ir audito taisyklėmis kaip ir interneto portalas.
  • Backend'as pagal diegimo konfigūraciją gali naudoti skirtingas žemesnio lygio AI paslaugas.
  • Užduočių atsakymai apima bendrą result_summary objektą, todėl skirtingos paslaugos gali rodyti skirtingus rezultatų tipus.

Autentifikacija

  • Prisijunkite svetainėje ir sukurkite API raktą API raktų puslapyje.
  • Pilnas API raktas rodomas tik vieną kartą, kai jis sukuriamas.
  • Su kiekviena užklausa siųskite raktą Authorization antraštėje.
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

Įkėlimo taisyklės

  • Maksimalus failo dydis: 20MB vienam paveikslėliui.
  • Palaikomi formatai: JPEG, PNG, WEBP.
  • Backend'as tikrina tikrąjį failo turinį, o ne tik failo plėtinį.

Įkėlimo dydžio kontrolė

  • Paketiniai įkėlimai pagal nutylėjimą priima iki 8 paveikslėlių, su 20MB apribojimu vienam vaizdui ir 20MB bendro failo turinio limitu.
  • Failas ar partija, viršijanti savo limitą, grįžta 413 prieš vaizdo patvirtinimą ar užduoties kūrimą; Nėra sukuriama dalinė partija.
  • Backendas kontroliuoja faktinį gautų baitų skaičių net tada, kai trūksta Content-Length arba naudojamas fragmentuotas perdavimas.

Užduočių būsenos

  • queued: Priimta ir laukia AI apdorojimo.
  • running: Šiuo metu apdorojama, arba jau perduota dispečeriui ir būsena periodiškai tikrinama galutiniam rezultatui gauti.
  • batch_waiting_ai: Kiekvienas partijos elementas laukia, kol AI paslauga vėl prisijungs.
  • batch_running: Partija jau perduota dispečeriui ir vis dar apdorojama.
  • done: Sėkmingai baigta.
  • failed: Apdorojimas nepavyko.
  • waiting_ai: Laukia eilėje, kol AI paslauga vėl prisijungs, tada automatiškai tęsiama.

Rezultatų šaltiniai

  • fresh: Sugeneruota nauju AI apdorojimu.
  • cached_exact: Atitiko dabartinės AI versijos talpyklą.
  • cached_stale: AI neprisijungęs, todėl grąžintas naujausias talpykloje įrašytas rezultatas.
  • pending: Galutinio rezultato dar nėra.
  • failed: Užduotis nepavyko.
  • Kai užduotis dar nebaigta, patikrinkite error_message dėl naujausio pakartotinio bandymo ar laukimo priežasties.

Kvotos ir atsiskaitymai

  • Naudokite `GET /api/open/quota` prieš pateikiant didelius darbo krūvius, jei integracijai reikia išvengti kvotų nesėkmių.
  • Tik naujas AI apdorojimas su rezultatu `fresh` sunaudoja kvotą.
  • `cached_exact`, `cached_stale`, `pending`, ir `failed` rezultatai nenaudoja kvotos.
  • Nemokamos paskyros pirmiausia naudoja dienos kvotą. Mokamos sąskaitos naudoja aktyvius periodinius kvotų paketus, tada laikinus arba fiksuotus kvotus pagal vidinę politiką.
  • Kai kvota išnaudojama, užduoties pateikimas grąžina `429` ir vietoj naujos užduoties sukūrimo pateikia klaidos pranešimą.

Talpyklos ir rezultatų šviežumas

  • Backend'as sėkmingus rezultatus talpina pagal vaizdo maišą ir AI versiją, įskaitant žemesnio lygio paslaugos namespace.
  • `cached_exact` reiškia, kad tas pats paveikslėlis jau turi sėkmingą rezultatą dabartinėje AI versijoje, todėl naujų AI paleisti nereikėjo.
  • `cached_stale` reiškia, kad AI paslauga yra neprisijungusi, o backend'as grąžina naujausią istorinį rezultatą.
  • Kai `is_latest_ai_version` yra false, išsaugokite rezultatą kaip naudingus, bet peržiūrimus istorinius duomenis.
  • Nesitikėkite, kad kiekviena sunaudota `done` užduotis yra kvota; Patikrinkite `result_source`.

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

Perskaitykite dabartinę kvotą ir likusį naudojimą.

Prašymo pavyzdys
curl -X GET "https://watermeterai.com/api/open/quota" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Atsako pavyzdys
{
  "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

Perskaitykite viešosios paslaugos statusą dėl užduoties pateikimo ir talpyklos rezultatų atsarginio varianto.

Prašymo pavyzdys
curl -X GET "https://watermeterai.com/api/open/ai-status" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Atsako pavyzdys
{
  "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

Įkelkite vieną paveikslėlį ir sukurkite vieną užduotį.

Prašymo pavyzdys
curl -X POST "https://watermeterai.com/api/open/tasks" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx" \
  -F "file=@D:\data\meter_001.jpg"
Atsako pavyzdys
{
  "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}

Perskaitykite vienos užduoties būseną ir galutinį skaitymą.

Prašymo pavyzdys
curl -X GET "https://watermeterai.com/api/open/tasks/task_a" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Atsako pavyzdys
{
  "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

Perskaitykite naujausias užduotis, kurias valdo dabartinis API pagrindinis vartotojas.

Prašymo pavyzdys
curl -X GET "https://watermeterai.com/api/open/tasks?limit=20" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Atsako pavyzdys
{
  "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

Įkelkite kelias nuotraukas vienu užsakymu.

Prašymo pavyzdys
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"
Atsako pavyzdys
{
  "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}

Skaitykite partijų eigą ir užduočių būsenas kiekvienam failui.

Prašymo pavyzdys
curl -X GET "https://watermeterai.com/api/open/batches/5a14f4e5f6d34fdabce00e62c0dd0001" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Atsako pavyzdys
{
  "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": ""
    }
  ]
}

Rekomenduojamas srautas

  • Patikrinkite `GET /api/open/ai-status` prieš siųsdami didelius darbo krūvius.
  • Laikykite `task_id` ar `batch_id` savo sistemoje iškart po pateikimo.
  • Traktuokite `queued`, `running`, `waiting_ai`, `batch_waiting_ai` ir `batch_running` kaip negalutines būsenas ir toliau periodiškai tikrinkite būseną.
  • Naudokite paketines užklausas, kai tinklo kelio į backendą delsa didelė ir įdiegta paslauga palaiko partijų režimą.
  • Šiuo metu paketinės užklausos praeina per `webBackend -> dispatchCenter -> waterMeterAi`.
  • `batch_waiting_ai` reiškia, kad kiekvienas daiktas vis dar laukia AI paslaugos ir dar nėra aktyviai veikiantis.
  • Kai įdiegta paslauga yra `CAD`, kol kas naudokite `POST /api/open/tasks` ir laikykite partijų įkėlimą neprieinamu.

Klaidos pastabos

  • 400: neteisinga užklausa arba įdiegta paslauga nepalaiko paketinio įkėlimo.
  • 401: dingęs, negaliojantis, pasibaigęs arba išjungtas API raktas.
  • 403: the user account is not active, the key lacks the required scope, or the source IP is outside the key allowlist.
  • 404: užduotis ar partija nerasta arba nepriklauso dabartiniam vartotojui.
  • 413: failas per didelis.
  • 415: nepalaikomas paveikslėlio tipas arba netinkamas vaizdo turinys.
  • 429: quota exhausted or the API key request, submission, or concurrency limit was exceeded.
400 paketinis įkėlimas nepasiekiamas
{
  "detail": "batch upload is not supported for business: cax"
}
401 trūkstamą ar negaliojantį API raktą
{
  "ok": false,
  "error": "unauthorized",
  "message": "Missing or invalid API key."
}
413 failas per didelis
{
  "ok": false,
  "error": "file_too_large",
  "message": "Maximum file size is 20MB."
}
429 kvota išnaudota
{
  "ok": false,
  "error": "quota_exhausted",
  "message": "Quota exhausted.",
  "quota": {
    "remaining": 0,
    "quota_summary_text": "Free daily quota: 20/20 used today. Remaining: 0."
  }
}

Pasiruošę išbandyti darbo eigą?

Pirmajai nuotraukai naudokite žiniatinklio darbo erdvę, o kai rezultato formatas tiks jūsų sistemai, pereikite prie API raktų.

Registruokitės ir įkelkite nuotraukąSukurkite API raktą