API OCR ສຳລັບມິເຕີນ້ຳ

API OCR ສຳລັບມິເຕີນ້ຳ. ຫນ້ານີ້ບັນທຶກຂໍ້ມູນສາທາລະນະ HTTP API ທີ່ເວັບໄຊທ໌ໄດ້ເຜີຍແຜ່ສໍາລັບການເຊື່ອມຕໍ່ກັບພາກສ່ວນທີສາມ.

ເລີ່ມດ້ວຍການອັບໂຫລດຈິງໆ

ລົງທະບຽນກ່ອນ, ອັບໂຫລດຮູບພາບເຄື່ອງມືວັດນ້ໍາຂອງທ່ານໃນພື້ນທີ່ທໍາງານ, ແລ້ວສ້າງປຸ່ມ API ເມື່ອທ່ານພ້ອມທີ່ຈະປະສົມລວມ.

ລົງທະບຽນແລະອັບໂຫຼດຮູບພາບ ສ້າງ API Key

ຈຸດສິ້ນສຸດການຄົ້ນຫາ

ພາບລວມ

ໃຊ້ສ່ວນຫຼັງຂອງເວັບໄຊທ໌ສໍາລັບການເຊື່ອມຕໍ່ພາຍນອກທັງຫມົດ.
ຢ່າເອີ້ນ waterMeterAi ໂດຍກົງຈາກໂປຣແກຣມພາຍນອກ.
Open API ແບ່ງປັນຜູ້ໃຊ້, ໂຄຕາ, ແຄຊ, ວຽກງານ, ແລະກົດການກວດສອບເຫມືອນກັບພອດທໍເວັບ.
Backend ສາມາດເລືອກບໍລິການ AI ປາຍທາງທີ່ແຕກຕ່າງກັນຕາມການຕັ້ງຄ່າ deployment.
ການຕອບກັບວຽກງານຕອນນີ້ລວມວັດຖຸທົ່ວໄປ result_summary ເພື່ອໃຫ້ບໍລິການຕ່າງໆສາມາດສະແດງຜົນລັບຫຼາຍປະເພດ.

ການຢືນຢັນ

ເຂົ້າລະບົບໃນເວັບໄຊແລະສ້າງລະຫັດ API ໃນຫນ້າ API Keys.
ຄີ 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 ຮູບໂດຍຄ່າເລີ່ມຕົ້ນ, ມີຂີດຈໍາກັດ 20MB ຕໍ່ຮູບພາບ ແລະຈໍາກັດເນື້ອຫາໄຟລ໌ລວມ 20MB.
ໄຟລ໌ ຫຼື ກຸ່ມງານທີ່ເກີນຂອບເຂດຈະສົ່ງຄືນ 413 ກ່ອນການກວດສອບຮູບພາບ ຫຼື ການສ້າງວຽກງານ; ບໍ່ມີການສ້າງຊຸດບາງສ່ວນ.
ພາກຫຼັງຈະບັນລຸຈໍານວນໄບດ໌ທີ່ຮັບໄດ້ຈິງເຖິງແມ່ນຈະຂາດຄວາມຍາວເນື້ອຫາຫຼືໃຊ້ການຖ່າຍໂອນທີ່ແບ່ງເປັນສ່ວນ.

ສະພາບວຽກງານ

ຢູ່ໃນຄິວ: ຖືກຍອມຮັບແລະກໍາລັງລໍຖ້າການດໍາເນີນການ AI .
ກໍາລັງເຮັດວຽກ: ກໍາລັງຖືກດໍາເນີນການ ຫຼືໄດ້ສົ່ງໃຫ້ຜູ້ຄວບຄຸມແລ້ວ ແລະຍັງກວດສອບສະຖານະເປັນໄລຍະເພື່ອຮັບຜົນສຸດທ້າຍ.
batch_waiting_ai: ທຸກລາຍການໃນກຸ່ມກໍາລັງລໍຖ້າບໍລິການ AI ກັບມາອອນໄລນ໌ອີກຄັ້ງ.
batch_running: ກຸ່ມສິນຄ້າໄດ້ຖືກສົ່ງໃຫ້ຜູ້ຈັດສົ່ງແລ້ວ ແລະຍັງກໍາລັງດໍາເນີນການຢູ່.
ສໍາເລັດ: ສໍາເລັດສໍາເລັດ.
ລົ້ມເຫຼວ: ການປະມວນຜົນລົ້ມເຫຼວ.
waiting_ai: ລໍຖ້າຈົນກວ່າບໍລິການ AI ຈະກັບມາອອນໄລນ໌, ແລ້ວມັນຈະກັບມາເຮັດວຽກຕໍ່ອັດຕະໂນມັດ.

ແຫຼ່ງຜົນລັບ

Fresh: ສ້າງຂຶ້ນໂດຍການດຳເນີນ AI ໃໝ່.
cached_exact: ກົງກັບແຄຊເວີຊັນ AI ປັດຈຸບັນ.
cached_stale: AI ອອບໄລນ໌, ຜົນລັບທີ່ເກັບໄວ້ລ່າສຸດຖືກສົ່ງກັບມາ.
ລໍຖ້າ: ຍັງບໍ່ມີຜົນສຸດທ້າຍ.
ລົ້ມເຫຼວ: ວຽກງານລົ້ມເຫຼວ.
ເມື່ອວຽກຍັງບໍ່ໄດ້ສໍາເລັດ, ກວດເບິ່ງ error_message ເພື່ອຄົ້ນຫາເຫດຜົນການລອງໃຫມ່ຫຼືການລໍຖ້າລ່າສຸດ.

ໂຄຕາ ແລະ ການຄິດຄ່າ

ໃຊ້ `GET /api/open/quota` ກ່ອນສົ່ງງານຈໍານວນຫຼາຍ ຖ້າການລວມລະບົບຂອງທ່ານຕ້ອງການຫຼີກເວັ້ນການລົ້ມເຫຼວຂອງໂຄຕາ.
ມີແຕ່ `fresh` AI ຄັ້ງເທົ່ານັ້ນທີ່ໃຊ້ໂຄຕາ.
`cached_exact`, `cached_stale`, `pending`, ແລະ `failed` ບໍ່ໃຊ້ໂຄຕາ.
ບັນຊີຟຣີໃຊ້ໂຄຕາປະຈໍາວັນກ່ອນ. ບັນຊີທີ່ຈ່າຍເງິນໃຊ້ແພັກເກັດໂຄຕາແບບເປັນລະຍະ, ແລ້ວໃຊ້ໂຄຕາຊົ່ວຄາວ ຫຼື ໂຄຕາຄົງທີ່ຕາມນະໂຍບາຍ backend.
ເມື່ອໂຄຕາຫມົດ, ການສົ່ງວຽກງານຈະສົ່ງຄືນ `429` ແລະມີຂໍ້ຄວາມຜິດພາດແທນການສ້າງວຽກງານໃຫມ່.

ແຄຊແລະຄວາມສົດໃຫມ່ຂອງຜົນລັບ

Backend ຈະເກັບຜົນລັບທີ່ສຳເລັດຕາມ image hash ແລະເວີຊັນ AI ລວມທັງ namespace ຂອງບໍລິການປາຍທາງ.
`cached_exact` ຫມາຍຄວາມວ່າຮູບພາບດຽວກັນໄດ້ສໍາເລັດແລ້ວສໍາລັບຮຸ່ນ AI ປະຈຸບັນ, ດັ່ງນັ້ນບໍ່ຈໍາເປັນຕ້ອງເຮັດ AI ໃຫມ່.
`cached_stale` ຫມາຍຄວາມວ່າບໍລິການ AI ຢູ່ອອບລາຍ ແລະລະບົບຫຼັງບ້ານສົ່ງຄືນຜົນລັບປະຫວັດສາດລ່າສຸດທີ່ມີຢູ່.
ເມື່ອ `is_latest_ai_version` ບໍ່ຖືກຕ້ອງ, ເກັບຜົນລັບເປັນຂໍ້ມູນປະຫວັດສາດທີ່ໃຊ້ງານໄດ້ ແຕ່ສາມາດກວດສອບໄດ້.
ຢ່າສົມມຸດວ່າທຸກວຽກງານ `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` ເປັນສະຖານະທີ່ຍັງບໍ່ສຸດທ້າຍ ແລະກວດສອບສະຖານະເປັນໄລຍະຕໍ່ໄປ.
ໃຊ້ຄຳຮ້ອງຂໍແບບກຸ່ມເມື່ອເສັ້ນທາງເຄືອຂ່າຍໄປຫາ backend ມີ latency ສູງ ແລະບໍລິການທີ່ deploy ແລ້ວຮອງຮັບໂໝດກຸ່ມ.
ຄໍາຮ້ອງຂໍແບບກຸ່ມກໍາລັງໄຫຼຜ່ານ `webBackend -> dispatchCenter -> waterMeterAi`.
`batch_waiting_ai` ຫມາຍຄວາມວ່າທຸກລາຍການຍັງລໍຖ້າບໍລິການ AI ແລະຍັງບໍ່ໄດ້ເຮັດວຽກຢ່າງເປັນທາງການ.
ເມື່ອບໍລິການທີ່ deploy ແລ້ວແມ່ນ `CAD` ໃຫ້ໃຊ້ `POST /api/open/tasks` ກ່ອນ ແລະຖືວ່າການອັບໂຫຼດແບບກຸ່ມຍັງບໍ່ພ້ອມ.

ຫມາຍເຫດຜິດພາດ

400: ຄຳຮ້ອງຂໍບໍ່ຖືກຕ້ອງ ຫຼືບໍລິການທີ່ deploy ແລ້ວບໍ່ຮອງຮັບການອັບໂຫຼດແບບກຸ່ມ.
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 Key

API OCR ສຳລັບມິເຕີນ້ຳ

ເລີ່ມດ້ວຍການອັບໂຫລດຈິງໆ

ພາບລວມ

ການຢືນຢັນ

API Key Permissions and Limits

ກົດການອັບໂຫລດ

ການບັງຄັບຂະຫນາດການອັບໂຫລດ

ສະພາບວຽກງານ

ແຫຼ່ງຜົນລັບ

ໂຄຕາ ແລະ ການຄິດຄ່າ

ແຄຊແລະຄວາມສົດໃຫມ່ຂອງຜົນລັບ

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}

ແນະນໍາການໄຫຼ

ຫມາຍເຫດຜິດພາດ

ພ້ອມທີ່ຈະທົດສອບການເຮັດວຽກບໍ?

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