Ūdens skaitītājs OCR API

Ūdens skaitītājs OCR API. Šī lapa dokumentē publisko HTTP API , ko vietnes aizmugure atklāj trešo pušu integrācijām.

Sāc ar īstu augšupielādi

Vispirms reģistrējieties, augšupielādējiet savu ūdens skaitītāja fotoattēlu darba vietā un pēc tam izveidojiet API atslēgu, kad būsiet gatavs integrēt.

Reģistrējieties un augšupielādējiet fotoattēlu Izveido API atslēgu

Meklēšanas galapunkti

Pārskats

Izmanto mājaslapas aizmuguri visām ārējām integrācijām.
Nezvaniet waterMeterAi tieši no trešo pušu programmām.
Atvērtais API koplieto tos pašus lietotājus, kvotu, kešatmiņu, uzdevumus un audita noteikumus kā tīmekļa portāls.
Aizmugures sistēma var izmantot dažādus pakārtotos AI pakalpojumus atbilstoši izvietošanas konfigurācijai.
Uzdevumu atbildes ietver vispārīgu result_summary objektu, lai dažādi pakalpojumi varētu attēlot dažādus rezultātu tipus.

Autentifikācija

Piesakieties mājaslapā un izveidojiet API atslēgu API Keys lapā.
Pilna API atslēga tiek parādīta tikai vienu reizi, kad tā tiek izveidota.
Sūti atslēgu Authorization galvenē katram pieprasījumam.

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

Augšupielādes noteikumi

Maksimālais faila izmērs: 20MB uz attēlu.
Atbalstītie formāti: JPEG, PNG, WEBP.
Backend pārbauda faktisko faila saturu, ne tikai faila paplašinājumu.

Augšupielādes izmēra uzraudzība

Partiju augšupielādes pēc noklusējuma pieņem līdz 8 attēliem, ar 20MB ierobežojumu uz attēlu un 20MB kopējā faila satura ierobežojumu.
Fails vai partija, kas pārsniedz savu limitu, atgriež 413 pirms attēlu validācijas vai uzdevuma izveides; daļēja partija netiek izveidota.
Aizmugures sistēma piemēro faktisko saņemto baitu skaitu pat tad, ja trūkst Content-Length vai tiek izmantota sadalīta pārsūtīšana.

Uzdevumu stāvokļi

queued: Pieņemts un gaida AI apstrādi.
running: Pašlaik tiek apstrādāts, vai jau nodots dispečeram un statuss tiek periodiski pārbaudīts, lai saņemtu galīgo rezultātu.
batch_waiting_ai: Katrs partijas elements gaida, kad AI pakalpojums atkal būs tiešsaistē.
batch_running: Partija jau ir nodota dispečeram un vēl tiek apstrādāta.
done: Veiksmīgi pabeigts.
failed: Apstrāde neizdevās.
waiting_ai: Gaida rindā, līdz AI pakalpojums atkal būs tiešsaistē, un pēc tam automātiski turpinās.

Rezultātu avoti

fresh: Ģenerēts ar jaunu AI apstrādi.
cached_exact: Sakrita ar pašreizējās AI versijas kešatmiņu.
cached_stale: AI ir bezsaistē, un atgriezts jaunākais kešotais rezultāts.
pending: Galīgā rezultāta vēl nav.
failed: Uzdevums neizdevās.
Kad uzdevums vēl nav pabeigts, pārbaudiet error_message par jaunāko atkārtoto mēģinājumu vai gaidīšanas iemeslu.

Kvotas un rēķini

Izmantojiet `GET /api/open/quota` pirms lielu darba apjomu iesniegšanas, ja integrācijai jāizvairās no kvotu neveiksmēm.
Kvotu patērē tikai jauna AI apstrāde ar rezultātu `fresh`.
`cached_exact`, `cached_stale`, `pending`, un `failed` rezultāti nepatērē kvotu.
Bezmaksas konti vispirms izmanto dienas kvotu. Apmaksātie konti izmanto aktīvas periodiskas kvotu paketes, pēc tam pagaidu vai fiksētas kvotas saskaņā ar backend politiku.
Kad kvota ir izsmelta, uzdevumu iesniegšana atgriež `429` un ietver kļūdas ziņojumu, nevis jauna uzdevuma izveidi.

Kešatmiņa un rezultātu svaigums

Aizmugures sistēma kešo veiksmīgus rezultātus pēc attēla jaucējkoda un AI versijas, ieskaitot pakārtotā pakalpojuma namespace.
`cached_exact` nozīmē, ka tam pašam attēlam jau ir veiksmīgs rezultāts pašreizējai AI versijai, tāpēc nebija nepieciešama jauna AI izpilde.
`cached_stale` nozīmē, ka AI pakalpojums ir bezsaistē un aizmugures daļa atgrieza jaunāko pieejamo vēsturisko rezultātu.
Ja `is_latest_ai_version` ir false, saglabājiet rezultātu kā izmantojamus, bet pārskatāmus vēsturiskos datus.
Neuzskatiet, ka katrs `done` uzdevums ir aprēķināts; Pārbaudiet `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`

Izlasiet pašreizējo kvotu un atlikušās lietošanas datus.

Pieprasījuma piemērs

curl -X GET "https://watermeterai.com/api/open/quota" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"

Atbildes piemērs

{
  "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`

Izlasiet publiskā pakalpojuma statusu uzdevuma iesniegšanai un kešoto rezultātu rezerves variantam.

Pieprasījuma piemērs

curl -X GET "https://watermeterai.com/api/open/ai-status" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"

Atbildes piemērs

{
  "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`

Augšupielādējiet vienu attēlu un izveidojiet vienu uzdevumu.

Pieprasījuma piemērs

curl -X POST "https://watermeterai.com/api/open/tasks" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx" \
  -F "file=@D:\data\meter_001.jpg"

Atbildes piemērs

{
  "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}`

Izlasiet vienu uzdevuma statusu un galīgo lasījumu.

Pieprasījuma piemērs

curl -X GET "https://watermeterai.com/api/open/tasks/task_a" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"

Atbildes piemērs

{
  "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`

Izlasiet nesenos uzdevumus, kas pieder pašreizējā API galvenajam lietotājam.

Pieprasījuma piemērs

curl -X GET "https://watermeterai.com/api/open/tasks?limit=20" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"

Atbildes piemērs

{
  "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`

Augšupielādējiet vairākus attēlus vienā pieprasījumā.

Pieprasījuma piemērs

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"

Atbildes piemērs

{
  "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}`

Lasiet partijas progresu un uzdevumu stāvokļus katram failam.

Pieprasījuma piemērs

curl -X GET "https://watermeterai.com/api/open/batches/5a14f4e5f6d34fdabce00e62c0dd0001" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"

Atbildes piemērs

{
  "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": ""
    }
  ]
}

Ieteicamā plūsma

Pārbaudiet `GET /api/open/ai-status` pirms sūtāt lielu darba apjomu.
Uzglabājiet `task_id` vai `batch_id` savā sistēmā uzreiz pēc iesniegšanas.
Uzskatiet `queued`, `running`, `waiting_ai`, `batch_waiting_ai` un `batch_running` par negalīgiem stāvokļiem un turpiniet periodiski pārbaudīt statusu.
Izmantojiet partijas pieprasījumus, ja tīkla ceļam uz aizmugures sistēmu ir augsts latentums un izvietotais pakalpojums atbalsta partijas režīmu.
Partijas pieprasījumi pašlaik plūst caur `webBackend -> dispatchCenter -> waterMeterAi`.
`batch_waiting_ai` nozīmē, ka katrs priekšmets joprojām gaida AI pakalpojumu, vēl nav aktīvi darbojies.
Kad izvietotais pakalpojums ir `CAD`, pagaidām izmantojiet `POST /api/open/tasks` un uzskatiet partiju augšupielādi par nepieejamu.

Kļūdu piezīmes

400: nederīgs pieprasījums vai izvietotais pakalpojums neatbalsta partijas augšupielādi.
401: trūkst, nederīga, beigusies vai atspējota API atslēga.
403: the user account is not active, the key lacks the required scope, or the source IP is outside the key allowlist.
404: uzdevums vai partija nav atrasta vai nepieder pašreizējam lietotājam.
413: fails pārāk liels.
415: neatbalstīts attēla tips vai nederīgs attēla saturs.
429: quota exhausted or the API key request, submission, or concurrency limit was exceeded.

400 partijas augšupielāde nav pieejama

{
  "detail": "batch upload is not supported for business: cax"
}

401 trūkst vai ir nederīga API atslēga

{
  "ok": false,
  "error": "unauthorized",
  "message": "Missing or invalid API key."
}

413 fails par lielu

{
  "ok": false,
  "error": "file_too_large",
  "message": "Maximum file size is 20MB."
}

429 kvota izsmelta

{
  "ok": false,
  "error": "quota_exhausted",
  "message": "Quota exhausted.",
  "quota": {
    "remaining": 0,
    "quota_summary_text": "Free daily quota: 20/20 used today. Remaining: 0."
  }
}

Gatavs pārbaudīt darba plūsmu?

Izmantojiet tīmekļa darba vidi pirmajai fotogrāfijai un pārejiet uz API atslēgām, kad rezultāta formāts atbilst jūsu sistēmai.

Reģistrējieties un augšupielādējiet fotoattēlu Izveido API atslēgu

Ūdens skaitītājs OCR API

Sāc ar īstu augšupielādi

Pārskats

Autentifikācija

API Key Permissions and Limits

Augšupielādes noteikumi

Augšupielādes izmēra uzraudzība

Uzdevumu stāvokļi

Rezultātu avoti

Kvotas un rēķini

Kešatmiņa un rezultātu svaigums

Task completion webhooks

GET/api/open/quota

GET/api/open/ai-status

POST/api/open/tasks

GET/api/open/tasks/{task_id}

GET/api/open/tasks

POST/api/open/batches

GET/api/open/batches/{batch_id}

Ieteicamā plūsma

Kļūdu piezīmes

Gatavs pārbaudīt darba plūsmu?

GET`/api/open/quota`

GET`/api/open/ai-status`

POST`/api/open/tasks`

GET`/api/open/tasks/{task_id}`

GET`/api/open/tasks`

POST`/api/open/batches`

GET`/api/open/batches/{batch_id}`