WaterMeter AI
МоваУкраїнська
Інші мови

API OCR лічильників води

API OCR лічильників води. Ця сторінка документує загальнодоступні HTTP API, надані серверною частиною веб-сайту для сторонніх інтеграцій.

Почніть із реального завантаження

Спочатку зареєструйтеся, завантажте власне фото водоміра у workspace, а потім створіть API key, коли будете готові до інтеграції.

Зареєструватися і завантажити фотоСтворити API key

Огляд

  • Використовуйте серверну частину веб-сайту для всіх зовнішніх інтеграцій.
  • Не викликайте waterMeterAi безпосередньо зі сторонніх програм.
  • Відкритий API використовує тих самих користувачів, квоту, кеш, завдання та правила аудиту, що й веб-портал.
  • Сервер може націлюватися на різні бізнеси AI нижнього рівня за допомогою конфігурації розгортання.
  • Відповіді на завдання тепер містять загальний об’єкт result_summary, щоб різні компанії могли відображати різні типи результатів.

Автентифікація

  • Увійдіть на веб-сайті та створіть ключ API на сторінці ключів API.
  • Повний ключ API відображається лише один раз під час його створення.
  • Надсилайте ключ у заголовку авторизації кожного запиту.
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

Правила завантаження

  • Максимальний розмір файлу: 20MB на зображення.
  • Підтримувані формати: JPEG, PNG, WEBP.
  • Сервер перевіряє фактичний вміст файлу, а не лише розширення файлу.

Застосування розміру завантаження

  • Пакетне завантаження приймає до 8 зображень за замовчуванням, з обмеженням 20 МБ на зображення та 20 МБ загального вмісту файлу.
  • Файл або пакет, який перевищує обмеження, повертає 413 перед перевіркою зображення або створенням завдання; часткова партія не створюється.
  • Сервер забезпечує фактичну кількість отриманих байтів, навіть якщо Content-Length відсутній або використовується передача з фрагментами.

Стан завдання

  • queued: прийнято та очікує обробки AI.
  • running: зараз обробляється або вже передано диспетчеру та все ще запитує остаточний результат.
  • batch_waiting_ai: кожен елемент у пакеті очікує, поки служба AI повернеться в режим онлайн.
  • batch_running: партія вже передана диспетчеру та ще обробляється.
  • done: завершено успішно.
  • failed: обробка failed.
  • waiting_ai: queued, доки служба AI не відновиться в режимі онлайн, після чого вона відновиться автоматично.

Джерела результатів

  • fresh: створено за допомогою нового запуску AI.
  • cached_exact: відповідав поточному кешу версії AI.
  • cached_stale: AI офлайн, повернуто останній кешований результат.
  • pending: остаточного результату ще немає.
  • failed: завдання failed.
  • Якщо завдання ще не done, перевірте error_message на предмет останньої повторної спроби або причини очікування.

Квота й тарифікація

  • Використовуйте `GET /api/open/quota` перед надсиланням великих навантажень, якщо інтеграції потрібно уникати помилок квоти.
  • Квоту споживають лише AI-запуски `fresh`.
  • Результати `cached_exact`, `cached_stale`, `pending` і `failed` не споживають квоту.
  • Безплатні акаунти спочатку використовують денну квоту. Платні акаунти використовують активні періодичні пакети квоти, потім тимчасову або фіксовану квоту згідно з політикою backend.
  • Коли квоту вичерпано, надсилання задачі повертає `429` і повідомлення про помилку замість створення нової задачі.

Кеш і актуальність результату

  • Backend кешує успішні результати за хешем зображення та версією AI, включно з namespace нижнього бізнесу.
  • `cached_exact` означає, що для цього самого зображення вже є успішний результат поточної версії AI, тому новий AI-запуск не був потрібен.
  • `cached_stale` означає, що AI-сервіс офлайн, а backend повернув найновіший доступний історичний результат.
  • Коли `is_latest_ai_version` дорівнює false, зберігайте результат як придатні до використання, але перевірні історичні дані.
  • Не вважайте, що кожна задача `done` спожила квоту; перевіряйте `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

Прочитайте поточну квоту та залишок використання.

Приклад запиту
curl -X GET "https://watermeterai.com/api/open/quota" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Приклад відповіді
{
  "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

Ознайомтеся зі статусом загальнодоступної служби для надсилання завдань і резервних кешованих результатів.

Приклад запиту
curl -X GET "https://watermeterai.com/api/open/ai-status" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Приклад відповіді
{
  "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

Завантажте одне зображення та створіть одне завдання.

Приклад запиту
curl -X POST "https://watermeterai.com/api/open/tasks" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx" \
  -F "file=@D:\data\meter_001.jpg"
Приклад відповіді
{
  "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}

Прочитайте статус одного завдання та остаточне читання.

Приклад запиту
curl -X GET "https://watermeterai.com/api/open/tasks/task_a" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Приклад відповіді
{
  "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

Прочитайте останні завдання, якими володіє поточний користувач ключа API.

Приклад запиту
curl -X GET "https://watermeterai.com/api/open/tasks?limit=20" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Приклад відповіді
{
  "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

Завантажте кілька зображень одним запитом.

Приклад запиту
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"
Приклад відповіді
{
  "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}

Перегляд пакетного прогресу та стану завдань для кожного файлу.

Приклад запиту
curl -X GET "https://watermeterai.com/api/open/batches/5a14f4e5f6d34fdabce00e62c0dd0001" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Приклад відповіді
{
  "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": ""
    }
  ]
}

Рекомендований потік

  • Перевірте `GET /api/open/ai-status` перед надсиланням великих робочих навантажень.
  • Зберігайте `task_id` або `batch_id` у власній системі одразу після надсилання.
  • Вважайте `queued`, `running`, `waiting_ai`, `batch_waiting_ai` та `batch_running` нефінальними станами та продовжуйте опитування.
  • Використовуйте пакетні запити, коли мережевий шлях до серверної частини має високу затримку, а розгорнуте підприємство підтримує пакетний режим.
  • Пакетні запити наразі надходять через `webBackend -> dispatchCenter -> waterMeterAi`.
  • `batch_waiting_ai` означає, що кожен елемент все ще очікує на службу AI, а running ще не активний.
  • Якщо розгорнутим бізнесом є `CAD`, наразі використовуйте `POST /api/open/tasks` та розглядайте пакетне завантаження як недоступне.

Примітки про помилки

  • 400: недійсний запит або розгорнуте підприємство не підтримує пакетне завантаження.
  • 401: відсутній, недійсний, прострочений або вимкнений ключ API.
  • 403: the user account is not active, the key lacks the required scope, or the source IP is outside the key allowlist.
  • 404: завдання чи пакет не знайдено або не належить поточному користувачеві.
  • 413: файл завеликий.
  • 415: непідтримуваний тип зображення або недійсний вміст зображення.
  • 429: quota exhausted or the API key request, submission, or concurrency limit was exceeded.
Пакетне завантаження 400 недоступне
{
  "detail": "batch upload is not supported for business: cax"
}
401 відсутній або недійсний ключ API
{
  "ok": false,
  "error": "unauthorized",
  "message": "Missing or invalid API key."
}
413 файл завеликий
{
  "ok": false,
  "error": "file_too_large",
  "message": "Maximum file size is 20MB."
}
429 квоту вичерпано
{
  "ok": false,
  "error": "quota_exhausted",
  "message": "Quota exhausted.",
  "quota": {
    "remaining": 0,
    "quota_summary_text": "Free daily quota: 20/20 used today. Remaining: 0."
  }
}

Готові протестувати workflow?

Використайте web workspace для першого фото, а потім перейдіть до API keys, коли формат результату підійде вашій системі.

Зареєструватися і завантажити фотоСтворити API key