Utility Bill Analysis

​

Analyzes a utility bill image or PDF to extract consumption data. Allowed MIME types: image/jpeg, image/jpg, image/png, image/webp, application/pdf. Max file size: 3MB.

Body

required
application/json

Responses

  • application/json
  • application/json
  • application/json
Request Example for post/external/v1/utility-bill/analyze
curl https://sales-api.artemis.solar/external/v1/utility-bill/analyze \
  --request POST \
  --header 'x-api-key: YOUR_SECRET_TOKEN' \
  --form 'file=@filename' \
  --form 'projectId=123e4567-e89b-12d3-a456-426614174000'
{
  "success": true,
  "data": {
    "analysisId": "123e4567-e89b-12d3-a456-426614174000",
    "consumption": {
      "annualKwh": 1,
      "currentPeriodKwh": 1,
      "monthlyKwh": {
        "january": 1,
        "february": 1,
        "march": 1,
        "april": 1,
        "may": 1,
        "june": 1,
        "july": 1,
        "august": 1,
        "september": 1,
        "october": 1,
        "november": 1,
        "december": 1
      }
    },
    "confidence": {
      "score": 1
    },
    "validation": {
      "isValid": true,
      "meetsRequirements": true
    },
    "metadata": {
      "fileName": "string",
      "analyzedAt": "2026-11-16T17:59:29.234Z"
    },
    "serviceAddress": {
      "street": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "string"
    },
    "accountHolderName": {
      "firstName": "string",
      "lastName": "string",
      "fullName": "string"
    }
  }
}