WaterMeter AI
ഭാഷമലയാളം
മറ്റ് ഭാഷകൾ

വാട്ടർ മീറ്റർ OCR API

വാട്ടർ മീറ്റർ OCR API. മൂന്നാം കക്ഷി സംയോജനങ്ങൾക്കായി വെബ്‌സൈറ്റ് ബാക്ക്എൻഡ് വെളിപ്പെടുത്തിയ പൊതു HTTP API ഈ പേജ് ഡോക്യുമെൻ്റ് ചെയ്യുന്നു.

ഒരു യഥാർത്ഥ അപ്‌ലോഡ് ഉപയോഗിച്ച് ആരംഭിക്കുക

ആദ്യം രജിസ്റ്റർ ചെയ്യുക, വർക്ക്‌സ്‌പെയ്‌സിൽ നിങ്ങളുടെ സ്വന്തം വാട്ടർ മീറ്റർ ഫോട്ടോ അപ്‌ലോഡ് ചെയ്യുക, തുടർന്ന് നിങ്ങൾ സംയോജിപ്പിക്കാൻ തയ്യാറാകുമ്പോൾ ഒരു API കീ സൃഷ്‌ടിക്കുക.

ഒരു ഫോട്ടോ രജിസ്റ്റർ ചെയ്ത് അപ്‌ലോഡ് ചെയ്യുകഒരു API കീ സൃഷ്ടിക്കുക

അവലോകനം

  • എല്ലാ ബാഹ്യ സംയോജനങ്ങൾക്കും വെബ്സൈറ്റ് ബാക്കെൻഡ് ഉപയോഗിക്കുക.
  • മൂന്നാം കക്ഷി പ്രോഗ്രാമുകളിൽ നിന്ന് നേരിട്ട് waterMeterAi-ലേക്ക് വിളിക്കരുത്.
  • തുറന്ന API വെബ് പോർട്ടലിൻ്റെ അതേ ഉപയോക്താക്കൾ, ക്വാട്ട, കാഷെ, ടാസ്‌ക്കുകൾ, ഓഡിറ്റ് നിയമങ്ങൾ എന്നിവ പങ്കിടുന്നു.
  • വിന്യാസ കോൺഫിഗറേഷൻ അനുസരിച്ച് ബാക്കെൻഡിന് വ്യത്യസ്ത ഡൗൺസ്ട്രീം AI സേവനങ്ങൾ തിരഞ്ഞെടുക്കാനാകും.
  • ടാസ്‌ക് പ്രതികരണങ്ങളിൽ ഇപ്പോൾ പൊതുവായ result_summary ഒബ്‌ജക്റ്റ് ഉൾപ്പെടുന്നു; അതിനാൽ വ്യത്യസ്ത സേവനങ്ങൾക്ക് വ്യത്യസ്ത ഫല തരങ്ങൾ കാണിക്കാനാകും.

പ്രാമാണീകരണം

  • വെബ്‌സൈറ്റിൽ സൈൻ ഇൻ ചെയ്‌ത് API കീസ് പേജിൽ ഒരു API കീ സൃഷ്‌ടിക്കുക.
  • പൂർണ്ണ API കീ സൃഷ്‌ടിക്കുമ്പോൾ ഒരിക്കൽ മാത്രമേ കാണിക്കൂ.
  • ഓരോ അഭ്യർത്ഥനയിലും Authorization തലക്കെട്ടിൽ കീ അയയ്‌ക്കുക.
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 ഇമേജുകൾ വരെ സ്വീകരിക്കുന്നു, ഓരോ ചിത്രത്തിനും 20MB പരിധിയും 20MB മൊത്തം ഫയൽ-ഉള്ളടക്ക പരിധിയും.
  • ഇമേജ് മൂല്യനിർണ്ണയത്തിനോ ടാസ്‌ക് സൃഷ്‌ടിക്കുന്നതിന് മുമ്പോ അതിൻ്റെ പരിധി കവിയുന്ന ഒരു ഫയലോ ബാച്ചോ 413 നൽകുന്നു; ഒരു ഭാഗിക ബാച്ച് സൃഷ്ടിക്കപ്പെട്ടിട്ടില്ല.
  • Content-Length നഷ്‌ടപ്പെടുമ്പോഴോ ചങ്ക്ഡ് ട്രാൻസ്ഫർ ഉപയോഗിക്കുമ്പോഴോ പോലും ബാക്കെൻഡ് യഥാർത്ഥ സ്വീകരിച്ച ബൈറ്റ് എണ്ണം നടപ്പിലാക്കുന്നു.

ടാസ്ക് സ്റ്റേറ്റ്സ്

  • queued: സ്വീകരിച്ചു, AI പ്രോസസ്സിംഗിനായി കാത്തിരിക്കുന്നു.
  • running: നിലവിൽ പ്രോസസ്സ് ചെയ്യുന്നു, അല്ലെങ്കിൽ ഡിസ്പാച്ചർക്ക് കൈമാറിയ ശേഷം അന്തിമ ഫലത്തിന്റെ നില ഇടയ്ക്കിടെ പരിശോധിക്കുന്നു.
  • batch_waiting_ai: ബാച്ചിലെ എല്ലാ ഇനങ്ങളും AI സേവനം ഓൺലൈനിൽ തിരികെ വരുന്നതിനായി കാത്തിരിക്കുന്നു.
  • batch_running: ബാച്ച് ഇതിനകം ഡിസ്പാച്ചർക്ക് കൈമാറി, ഇപ്പോഴും പ്രോസസ്സ് ചെയ്യുന്നു.
  • done: വിജയകരമായി പൂർത്തിയാക്കി.
  • failed: പ്രോസസ്സിംഗ് പരാജയപ്പെട്ടു.
  • waiting_ai: AI സേവനം ഓൺലൈനിൽ തിരികെ വരുന്നതുവരെ ക്യൂവിലാണ്, തുടർന്ന് അത് യാന്ത്രികമായി പുനരാരംഭിക്കും.

ഫല സ്രോതസ്സുകൾ

  • fresh: ഒരു പുതിയ AI റൺ സൃഷ്ടിച്ചത്.
  • cached_exact: നിലവിലെ AI പതിപ്പ് കാഷെയുമായി പൊരുത്തപ്പെടുന്നു.
  • cached_stale: AI ഓഫ്‌ലൈനിൽ, ഏറ്റവും പുതിയ കാഷെ ചെയ്‌ത ഫലം ലഭിച്ചു.
  • pending: ഇതുവരെ അന്തിമഫലമില്ല.
  • failed: ടാസ്‌ക് പരാജയപ്പെട്ടു.
  • ഒരു ടാസ്‌ക് ഇതുവരെ ചെയ്‌തിട്ടില്ലെങ്കിൽ, ഏറ്റവും പുതിയ പുനഃശ്രമത്തിനോ കാത്തിരിപ്പിൻ്റെ കാരണത്തിനോ വേണ്ടി error_message പരിശോധിക്കുക.

ക്വാട്ടയും ബില്ലിംഗും

  • നിങ്ങളുടെ സംയോജനത്തിന് ക്വാട്ട പരാജയങ്ങൾ ഒഴിവാക്കണമെങ്കിൽ വലിയ ജോലിഭാരങ്ങൾ സമർപ്പിക്കുന്നതിന് മുമ്പ് `GET /api/open/quota` ഉപയോഗിക്കുക.
  • `fresh` AI റണ്ണുകൾ മാത്രമേ ക്വാട്ട ഉപയോഗിക്കൂ.
  • `cached_exact`, `cached_stale`, `pending`, `failed` ഫലങ്ങൾ ക്വാട്ട ഉപയോഗിക്കില്ല.
  • സൗജന്യ അക്കൗണ്ടുകൾ ആദ്യം പ്രതിദിന ക്വാട്ട ഉപയോഗിക്കുന്നു. പണമടച്ചുള്ള അക്കൗണ്ടുകൾ സജീവമായ ആനുകാലിക ക്വാട്ട പാക്കേജുകൾ ഉപയോഗിക്കുന്നു, തുടർന്ന് ബാക്കെൻഡ് പോളിസി അനുസരിച്ച് താൽക്കാലിക അല്ലെങ്കിൽ നിശ്ചിത ക്വാട്ട.
  • ക്വാട്ട തീരുമ്പോൾ, ടാസ്‌ക് സമർപ്പിക്കൽ `429` നൽകുന്നു, കൂടാതെ ഒരു പുതിയ ടാസ്‌ക് സൃഷ്‌ടിക്കുന്നതിന് പകരം ഒരു പിശക് സന്ദേശം ഉൾപ്പെടുന്നു.

കാഷെ, ഫലം പുതുമ

  • ഡൗൺസ്ട്രീം സേവനത്തിന്റെ namespace ഉൾപ്പെടെ, ഇമേജ് ഹാഷും AI പതിപ്പും അനുസരിച്ച് ബാക്കെൻഡ് വിജയകരമായ ഫലങ്ങൾ കാഷെ ചെയ്യുന്നു.
  • `cached_exact` എന്നാൽ അതേ ചിത്രത്തിന് നിലവിലെ AI പതിപ്പിന് ഇതിനകം ഒരു വിജയകരമായ ഫലമുണ്ട്, അതിനാൽ പുതിയ AI റൺ ആവശ്യമില്ല.
  • `cached_stale` എന്നതിനർത്ഥം AI സേവനം ഓഫ്‌ലൈനിലാണെന്നും ബാക്കെൻഡ് ലഭ്യമായ ഏറ്റവും പുതിയ ചരിത്രപരമായ ഫലം നൽകുന്നു.
  • `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 സേവനത്തിനായി കാത്തിരിക്കുന്നു, ഇതുവരെ സജീവമായി പ്രവർത്തിക്കുന്നില്ല.
  • വിന്യസിച്ച സേവനം `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."
  }
}

വർക്ക്ഫ്ലോ പരിശോധിക്കാൻ തയ്യാറാണോ?

ആദ്യ ഫോട്ടോയ്‌ക്കായി വെബ് വർക്ക്‌സ്‌പെയ്‌സ് ഉപയോഗിക്കുക, തുടർന്ന് ഫല ഫോർമാറ്റ് നിങ്ങളുടെ സിസ്റ്റത്തിന് അനുയോജ്യമാകുമ്പോൾ API കീകളിലേക്ക് നീങ്ങുക.

ഒരു ഫോട്ടോ രജിസ്റ്റർ ചെയ്ത് അപ്‌ലോഡ് ചെയ്യുകഒരു API കീ സൃഷ്ടിക്കുക