API za OCR vodomjera

API za OCR vodomjera. Ova stranica dokumentira javni HTTP API koji izlaže pozadina web-mjesta za integracije trećih strana.

Počnite s pravim prijenosom

Najprije se registrirajte, prenesite vlastitu fotografiju vodomjera u radni prostor, a zatim izradite API ključ kada budete spremni za integraciju.

Registrirajte se i prenesite fotografiju Izradite API ključ

Krajnje točke pretraživanja

Pregled

Koristite pozadinu web stranice za sve vanjske integracije.
Ne pozivajte waterMeterAi izravno iz programa trećih strana.
Otvoreni API dijeli iste korisnike, kvotu, predmemoriju, zadatke i pravila revizije kao i web portal.
Pozadina može usmjeravati zahtjeve prema različitim nizvodnim AI uslugama pomoću konfiguracije implementacije.
Odgovori na zadatke uključuju generički objekt result_summary kako bi različite usluge mogle prikazati različite vrste rezultata.

Autentifikacija

Prijavite se na web-mjesto i izradite API ključ na stranici API ključevi.
Cijeli API ključ prikazuje se samo jednom, pri izradi.
Pošaljite ključ u zaglavlju Authorization uz svaki zahtjev.

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

Pravila prijenosa

Maksimalna veličina datoteke: 20 MB po slici.
Podržani formati: JPEG, PNG, WEBP.
Pozadina potvrđuje stvarni sadržaj datoteke, a ne samo ekstenziju datoteke.

Provedba veličine prijenosa

Skupni prijenosi prihvaćaju do 8 slika prema zadanim postavkama, s ograničenjem od 20 MB po slici i ograničenjem ukupnog sadržaja datoteke od 20 MB.
Datoteka ili serija koja prelazi svoje ograničenje vraća 413 prije provjere valjanosti slike ili stvaranja zadatka; ne stvara se djelomična serija.
Pozadina provodi stvarni primljeni broj bajtova čak i kada nedostaje Content-Length ili se koristi prijenos u komadima.

Stanja zadatka

queued: prihvaćeno i čeka AI obradu.
running: trenutno se obrađuje ili je već predano dispečeru i još čeka konačni rezultat.
batch_waiting_ai: svaka stavka u seriji čeka da se usluga AI vrati na mrežu.
batch_running: serija je već predana otpremniku i još uvijek se obrađuje.
done: uspješno završeno.
failed: obrada nije uspjela.
waiting_ai: na čekanju dok se usluga AI ne vrati na mrežu, a zatim se automatski nastavlja.

Izvori rezultata

fresh: generirano novim pokretanjem AI-ja.
cached_exact: odgovara trenutnoj predmemoriji verzije AI.
cached_stale: AI izvan mreže, vraćen je zadnji rezultat u predmemoriji.
pending: još nema konačnog rezultata.
failed: zadatak nije uspio.
Kada zadatak još nije dovršen, provjerite error_message za posljednji ponovni pokušaj ili razlog čekanja.

Kvota i naplata

Upotrijebite `GET /api/open/quota` prije podnošenja velikih radnih opterećenja ako vaša integracija treba izbjeći kvarove kvote.
Samo `fresh` pokretanja AI-ja troše kvotu.
Rezultati `cached_exact`, `cached_stale`, `pending` i `failed` ne troše kvotu.
Besplatni računi prvi koriste dnevnu kvotu. Plaćeni računi koriste aktivne periodične pakete kvota, zatim privremene ili fiksne kvote u skladu s pozadinskom politikom.
Kada je kvota iscrpljena, podnošenje zadatka vraća `429` i uključuje poruku o pogrešci umjesto stvaranja novog zadatka.

Predmemorija i svježina rezultata

Pozadina sprema uspješne rezultate prema sažetku slike i verziji AI-ja, uključujući prostor naziva nizvodne usluge.
`cached_exact` znači da ista slika već ima uspješan rezultat za trenutnu verziju AI, tako da nije potrebno novo pokretanje AI.
`cached_stale` znači da je usluga AI izvan mreže i da je pozadina vratila najnoviji dostupni povijesni rezultat.
Kada je `is_latest_ai_version` netočan, pohranite rezultat kao upotrebljive, ali pregledne povijesne podatke.
Ne pretpostavljajte da je svaki `done` zadatak potrošio kvotu; provjerite `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`

Pročitajte trenutnu kvotu i preostalu upotrebu.

Primjer zahtjeva

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

Primjer odgovora

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

Pročitajte status javne usluge za podnošenje zadatka i rezervni rezultat u predmemoriji.

Primjer zahtjeva

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

Primjer odgovora

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

Prenesite jednu sliku i izradite jedan zadatak.

Primjer zahtjeva

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

Primjer odgovora

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

Pročitajte status jednog zadatka i konačno čitanje.

Primjer zahtjeva

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

Primjer odgovora

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

Pročitajte nedavne zadatke u vlasništvu trenutnog korisnika ključa API.

Primjer zahtjeva

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

Primjer odgovora

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

Prenesite više slika u jednom zahtjevu.

Primjer zahtjeva

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"

Primjer odgovora

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

Čitajte skupni napredak i stanja zadataka po datoteci.

Primjer zahtjeva

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

Primjer odgovora

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

Preporučeni postupak

Provjerite `GET /api/open/ai-status` prije slanja velikih radnih opterećenja.
Pohranite `task_id` ili `batch_id` u svoj sustav odmah nakon podnošenja.
Tretirajte `queued`, `running`, `waiting_ai`, `batch_waiting_ai` i `batch_running` kao nekonačna stanja i nastavite provjeravati status.
Koristite skupne zahtjeve kada mrežni put do pozadine ima veliku latenciju, a implementirana usluga podržava skupni način rada.
Skupni zahtjevi trenutno teku kroz `webBackend -> dispatchCenter -> waterMeterAi`.
`batch_waiting_ai` znači da svaka stavka još uvijek čeka uslugu AI, koja još nije aktivno pokrenuta.
Kada je raspoređeni posao `CAD`, za sada koristite `POST /api/open/tasks` i tretirajte skupni prijenos kao nedostupan.

Bilješke o pogrešci

400: nevažeći zahtjev ili implementirana usluga ne podržava skupni prijenos.
401: API ključ nedostaje, nije valjan, istekao je ili je onemogućen.
403: the user account is not active, the key lacks the required scope, or the source IP is outside the key allowlist.
404: zadatak ili serija nisu pronađeni ili nisu u vlasništvu trenutnog korisnika.
413: datoteka je prevelika.
415: nepodržana vrsta slike ili nevažeći sadržaj slike.
429: quota exhausted or the API key request, submission, or concurrency limit was exceeded.

400 skupni prijenos nije dostupan

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

401 API ključ nedostaje ili nije valjan

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

413 datoteka je prevelika

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

429 kvota je iscrpljena

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

Jeste li spremni testirati tijek rada?

Upotrijebite web-radni prostor za prvu fotografiju, a zatim prijeđite na API ključeve kada format rezultata odgovara vašem sustavu.

Registrirajte se i prenesite fotografiju Izradite API ključ

API za OCR vodomjera

Počnite s pravim prijenosom

Pregled

Autentifikacija

API Key Permissions and Limits

Pravila prijenosa

Provedba veličine prijenosa

Stanja zadatka

Izvori rezultata

Kvota i naplata

Predmemorija i svježina rezultata

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}

Preporučeni postupak

Bilješke o pogrešci

Jeste li spremni testirati tijek rada?

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