WaterMeter AI
SpråkNorsk
Andre språk

API for OCR av vannmålere

API for OCR av vannmålere. Denne siden dokumenterer det offentlige HTTP-API-et som nettstedets backend tilbyr for tredjepartsintegrasjoner.

Start med en ekte opplasting

Registrer deg først, last opp ditt eget vannmålerbilde i arbeidsområdet, og lag deretter en API-nøkkel når du er klar til å integrere.

Registrer deg og last opp et bildeOpprett en API-nøkkel

Oversikt

  • Bruk nettsidens backend for alle eksterne integrasjoner.
  • Ikke kall waterMeterAi direkte fra tredjepartsprogrammer.
  • Open API deler brukere, kvote, hurtigbuffer, oppgaver og revisjonsregler med nettportalen.
  • Backend kan rute til forskjellige underliggende AI-tjenester via distribusjonskonfigurasjonen.
  • Oppgavesvar inkluderer et generisk result_summary-objekt, slik at forskjellige tjenester kan vise forskjellige resultattyper.

Autentisering

  • Logg inn på nettstedet og opprett en API-nøkkel på siden API-nøkler.
  • Den fullstendige API-nøkkelen vises bare én gang når den er opprettet.
  • Send nøkkelen i Authorization-overskriften med hver forespørsel.
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

Opplastingsregler

  • Maksimal filstørrelse: 20 MB per bilde.
  • Støttede formater: JPEG, PNG, WEBP.
  • Bakenden validerer faktisk filinnhold, ikke bare filtypen.

Håndhevelse av opplastingsstørrelse

  • Batch-opplastinger godtar opptil 8 bilder som standard, med en grense på 20 MB per bilde og en totalgrense på 20 MB filinnhold.
  • En fil eller batch som overskrider grensen returnerer 413 før bildevalidering eller oppgaveoppretting; ingen delvis batch opprettes.
  • Bakenden håndhever det faktiske antallet byte som mottas selv når innholdslengde mangler eller overføring av deler brukes.

Oppgavestater

  • queued: akseptert og venter på AI-behandling.
  • running: behandles nå, eller er allerede sendt til ekspeditøren og venter fortsatt på det endelige resultatet.
  • batch_waiting_ai: hvert element i batchen venter på at AI-tjenesten skal komme tilbake online.
  • batch_running: batchen er allerede levert til avsenderen og behandles fortsatt.
  • done: fullført.
  • failed: behandlingen mislyktes.
  • waiting_ai: i kø til AI-tjenesten kommer tilbake på nett, deretter gjenopptas den automatisk.

Resultatkilder

  • fresh: generert av en ny AI-kjøring.
  • cached_exact: samsvarte med gjeldende AI-versjonsbuffer.
  • cached_stale: AI offline, siste hurtigbufrede resultat returnert.
  • pending: ikke noe endelig resultat ennå.
  • failed: oppgaven mislyktes.
  • Når en oppgave ikke er utført ennå, sjekk error_message for siste nytt forsøk eller årsak til å vente.

Kvote og fakturering

  • Bruk `GET /api/open/quota` før du sender inn store arbeidsbelastninger hvis integreringen din trenger å unngå kvotefeil.
  • Bare `fresh` AI-kjøringer bruker kvote.
  • Resultatene `cached_exact`, `cached_stale`, `pending` og `failed` bruker ikke kvote.
  • Gratis kontoer bruker den daglige kvoten først. Betalte kontoer bruker aktive periodiske kvotepakker, deretter midlertidig eller fast kvote i henhold til backend-policyen.
  • Når kvoten er oppbrukt, returnerer oppgaveinnsending `429` og inkluderer en feilmelding i stedet for å opprette en ny oppgave.

Hurtigbuffer og resultatfriskhet

  • Backend mellomlagrer vellykkede resultater etter bildehash og AI-versjon, inkludert navnerommet til den underliggende tjenesten.
  • `cached_exact` betyr at det samme bildet allerede har et vellykket resultat for den nåværende AI-versjonen, så ingen ny AI-kjøring var nødvendig.
  • `cached_stale` betyr at AI-tjenesten er frakoblet og backend returnerte det siste tilgjengelige historiske resultatet.
  • Når `is_latest_ai_version` er falsk, lagre resultatet som brukbare, men gjennomgåbare historiske data.
  • Ikke anta hver `done`-oppgave forbrukt kvote; sjekk `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

Les gjeldende kvote og gjenværende bruk.

Eksempel på forespørsel
curl -X GET "https://watermeterai.com/api/open/quota" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Eksempel på svar
{
  "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

Les statusen for offentlig tjeneste for oppgaveinnsending og bufret resultatreserve.

Eksempel på forespørsel
curl -X GET "https://watermeterai.com/api/open/ai-status" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Eksempel på svar
{
  "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

Last opp ett bilde og lag en enkelt oppgave.

Eksempel på forespørsel
curl -X POST "https://watermeterai.com/api/open/tasks" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx" \
  -F "file=@D:\data\meter_001.jpg"
Eksempel på svar
{
  "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}

Les status og endelig avlesning for én oppgave.

Eksempel på forespørsel
curl -X GET "https://watermeterai.com/api/open/tasks/task_a" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Eksempel på svar
{
  "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

Les nylige oppgaver som eies av brukeren til den gjeldende API-nøkkelen.

Eksempel på forespørsel
curl -X GET "https://watermeterai.com/api/open/tasks?limit=20" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Eksempel på svar
{
  "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

Last opp flere bilder i én forespørsel.

Eksempel på forespørsel
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"
Eksempel på svar
{
  "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}

Les batchfremdrift og oppgavetilstander per fil.

Eksempel på forespørsel
curl -X GET "https://watermeterai.com/api/open/batches/5a14f4e5f6d34fdabce00e62c0dd0001" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Eksempel på svar
{
  "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": ""
    }
  ]
}

Anbefalt flyt

  • Sjekk `GET /api/open/ai-status` før du sender store arbeidsmengder.
  • Lagre `task_id` eller `batch_id` i ditt eget system umiddelbart etter innsending.
  • Behandle `queued`, `running`, `waiting_ai`, `batch_waiting_ai` og `batch_running` som ikke-endelige tilstander, og fortsett å kontrollere status.
  • Bruk batchforespørsler når nettverksbanen til backend har høy ventetid og den distribuerte tjenesten støtter batchmodus.
  • Batchforespørsler flyter for øyeblikket gjennom `webBackend -> dispatchCenter -> waterMeterAi`.
  • `batch_waiting_ai` betyr at hvert element fortsatt venter på AI-tjenesten, og kjører ikke aktivt ennå.
  • Når den distribuerte tjenesten er `CAD`, bruker du foreløpig `POST /api/open/tasks` og behandler batchopplasting som utilgjengelig.

Feilmerknader

  • 400: ugyldig forespørsel, eller den distribuerte tjenesten støtter ikke batchopplasting.
  • 401: manglende, ugyldig, utløpt eller deaktivert API-nøkkel.
  • 403: the user account is not active, the key lacks the required scope, or the source IP is outside the key allowlist.
  • 404: oppgave eller batch ikke funnet, eller ikke eid av gjeldende bruker.
  • 413: filen er for stor.
  • 415: ustøttet bildetype eller ugyldig bildeinnhold.
  • 429: quota exhausted or the API key request, submission, or concurrency limit was exceeded.
400 batch-opplasting utilgjengelig
{
  "detail": "batch upload is not supported for business: cax"
}
401 mangler eller er ugyldig API-nøkkel
{
  "ok": false,
  "error": "unauthorized",
  "message": "Missing or invalid API key."
}
413-filen er for stor
{
  "ok": false,
  "error": "file_too_large",
  "message": "Maximum file size is 20MB."
}
429-kvoten er oppbrukt
{
  "ok": false,
  "error": "quota_exhausted",
  "message": "Quota exhausted.",
  "quota": {
    "remaining": 0,
    "quota_summary_text": "Free daily quota: 20/20 used today. Remaining: 0."
  }
}

Klar til å teste arbeidsflyten?

Bruk nettarbeidsområdet for det første bildet, og gå deretter over til API-nøkler når resultatformatet passer til systemet ditt.

Registrer deg og last opp et bildeOpprett en API-nøkkel