WaterMeter AI
IdiomaPortuguês
Outros idiomas

API OCR de contador de água

API OCR de contador de água. Esta página documenta a API HTTP pública exposta pelo backend do site para integrações de terceiros.

Comece com um envio real

Registe-se primeiro, carregue a sua fotografia do contador de água no espaço de trabalho e crie uma chave API quando estiver pronto para integrar.

Registrar e enviar uma fotoCriar uma chave API

Visão geral

  • Use o backend do site para todas as integrações externas.
  • Não chame waterMeterAi diretamente a partir de programas de terceiros.
  • A API aberta compartilha os mesmos usuários, cotas, cache, tarefas e regras de auditoria do portal web.
  • O backend pode direcionar diferentes negócios de IA downstream conforme a configuração de implantação.
  • As respostas de tarefas agora incluem um objeto genérico result_summary para que diferentes negócios possam exibir diferentes tipos de resultado.

Autenticação

  • Entre no site e crie uma chave API na página de chaves API.
  • A chave API completa é mostrada apenas uma vez quando é criada.
  • Envie a chave no cabeçalho Authorization em todas as solicitações.
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

Regras de upload

  • Tamanho máximo do arquivo: 20 MB por imagem.
  • Formatos suportados: JPEG, PNG, WEBP.
  • O backend valida o conteúdo real do arquivo, não apenas a extensão.

Aplicação de tamanho de upload

  • Os uploads em lote aceitam até 8 imagens por padrão, com um limite de 20 MB por imagem e um limite total de conteúdo do arquivo de 20 MB.
  • Um arquivo ou lote que excede seu limite retorna 413 antes da validação da imagem ou criação da tarefa; nenhum lote parcial é criado.
  • O back-end impõe a contagem real de bytes recebidos mesmo quando Content-Length está ausente ou quando uma transferência em partes é usada.

Estados da tarefa

  • queued: aceita e aguardando processamento por IA.
  • running: em processamento, ou já entregue ao despachante e ainda consultando o resultado final.
  • batch_waiting_ai: todos os itens do lote aguardam o serviço de IA voltar online.
  • batch_running: o lote já foi entregue ao despachante e ainda está sendo processado.
  • done: concluída com sucesso.
  • failed: o processamento falhou.
  • waiting_ai: na fila até o serviço de IA voltar online; depois continua automaticamente.

Fontes de resultado

  • fresh: gerado por uma nova execução de IA.
  • cached_exact: correspondeu ao cache da versão atual da IA.
  • cached_stale: IA offline, resultado mais recente em cache retornado.
  • pending: ainda sem resultado final.
  • failed: a tarefa falhou.
  • Quando uma tarefa ainda não terminou, verifique error_message para o motivo mais recente de nova tentativa ou espera.

Cota e cobrança

  • Use `GET /api/open/quota` antes de enviar grandes cargas de trabalho se sua integração precisa evitar falhas de cota.
  • Somente execuções AI `fresh` consomem cota.
  • Resultados `cached_exact`, `cached_stale`, `pending` e `failed` não consomem cota.
  • Contas gratuitas usam primeiro a cota diária. Contas pagas usam pacotes de cota periódica ativos e depois cota temporária ou fixa conforme a política do backend.
  • Quando a cota se esgota, o envio da tarefa retorna `429` e uma mensagem de erro em vez de criar uma nova tarefa.

Cache e atualização do resultado

  • O backend armazena resultados bem-sucedidos por hash da imagem e versão AI, incluindo o namespace do negócio downstream.
  • `cached_exact` significa que a mesma imagem já tem um resultado bem-sucedido para a versão AI atual, então nenhuma nova execução AI foi necessária.
  • `cached_stale` significa que o serviço AI está offline e o backend retornou o resultado histórico mais recente disponível.
  • Quando `is_latest_ai_version` for false, armazene o resultado como dado histórico utilizável, mas revisável.
  • Não presuma que toda tarefa `done` consumiu cota; verifique `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

Leia a cota atual e o uso restante.

Exemplo de solicitação
curl -X GET "https://watermeterai.com/api/open/quota" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Exemplo de resposta
{
  "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

Leia o status do serviço público para envio de tarefas e fallback de resultados em cache.

Exemplo de solicitação
curl -X GET "https://watermeterai.com/api/open/ai-status" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Exemplo de resposta
{
  "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

Carregue uma imagem e crie uma única tarefa.

Exemplo de solicitação
curl -X POST "https://watermeterai.com/api/open/tasks" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx" \
  -F "file=@D:\data\meter_001.jpg"
Exemplo de resposta
{
  "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}

Leia o status de uma tarefa e a leitura final.

Exemplo de solicitação
curl -X GET "https://watermeterai.com/api/open/tasks/task_a" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Exemplo de resposta
{
  "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

Leia as tarefas recentes pertencentes ao usuário da chave API atual.

Exemplo de solicitação
curl -X GET "https://watermeterai.com/api/open/tasks?limit=20" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Exemplo de resposta
{
  "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

Carregue várias imagens em uma solicitação.

Exemplo de solicitação
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"
Exemplo de resposta
{
  "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}

Leia o progresso do lote e os estados das tarefas por arquivo.

Exemplo de solicitação
curl -X GET "https://watermeterai.com/api/open/batches/5a14f4e5f6d34fdabce00e62c0dd0001" \
  -H "Authorization: Bearer wm_xxxxxxxxxxxxxxxxx"
Exemplo de resposta
{
  "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": ""
    }
  ]
}

Fluxo recomendado

  • Verifique `GET /api/open/ai-status` antes de enviar grandes cargas de trabalho.
  • Armazene `task_id` ou `batch_id` em seu próprio sistema imediatamente após o envio.
  • Trate `queued`, `running`, `waiting_ai`, `batch_waiting_ai` e `batch_running` como estados não finais e continue consultando.
  • Use solicitações em lote quando o caminho de rede até o backend tiver alta latência e o negócio implantado suportar modo em lote.
  • As solicitações em lote atualmente passam por `webBackend -> dispatchCenter -> waterMeterAi`.
  • `batch_waiting_ai` significa que todos os itens ainda aguardam o serviço de IA, não que estejam em execução ativa.
  • Quando o negócio implantado for `CAD`, use `POST /api/open/tasks` por enquanto e trate o upload em lote como indisponível.

Notas de erro

  • 400: solicitação inválida ou a empresa implantada não suporta upload em lote.
  • 401: chave API ausente, inválida, expirada ou desativada.
  • 403: the user account is not active, the key lacks the required scope, or the source IP is outside the key allowlist.
  • 404: tarefa ou lote não encontrado ou não pertencente ao usuário atual.
  • 413: arquivo muito grande.
  • 415: tipo de imagem não compatível ou conteúdo de imagem inválido.
  • 429: quota exhausted or the API key request, submission, or concurrency limit was exceeded.
Upload em lote 400 indisponível
{
  "detail": "batch upload is not supported for business: cax"
}
401 chave API ausente ou inválida
{
  "ok": false,
  "error": "unauthorized",
  "message": "Missing or invalid API key."
}
Arquivo 413 muito grande
{
  "ok": false,
  "error": "file_too_large",
  "message": "Maximum file size is 20MB."
}
Cota 429 esgotada
{
  "ok": false,
  "error": "quota_exhausted",
  "message": "Quota exhausted.",
  "quota": {
    "remaining": 0,
    "quota_summary_text": "Free daily quota: 20/20 used today. Remaining: 0."
  }
}

Pronto para testar o fluxo?

Use o workspace web para a primeira foto e depois avance para as chaves API quando o formato do resultado servir ao seu sistema.

Registrar e enviar uma fotoCriar uma chave API