Skip to content
HALOWERK

Bildwerk

meter reading

Crops the region, scales the digits to OCR height and reads them with Tesseract 5.3.4 limited to 0–9: plain, inverted and, with a region, digits isolated as connected components (Otsu, both polarities, not touching the window edge) to drop drum frames. Adjacent words are joined; the run with digits_total digits (else the longest, most confident) wins. decimals splits off decimal places; previous_reading gives consumption and a roll-over hint.

POST https://bild.halowerk.com/v1/meter-reading

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
image_base64stringNoImage (PNG/JPEG/WebP/GIF/TIFF/AVIF) as base64, ≤ 10 MB.
image_urlstringNoOr a public image URL.
regionobjectNoBox around the counter drums (recommended).
meter_typestringNoSets the default unit.
unitstringNoRegister unit (default by meter_type).
digits_totalintegerNoAll digits incl. decimals, if known.
decimalsintegerNoDigits after the decimal point (often red).
previous_readingnumberNoFor consumption and plausibility.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "image_base64": {
      "type": "string",
      "minLength": 16,
      "maxLength": 14000000,
      "description": "Image (PNG/JPEG/WebP/GIF/TIFF/AVIF) as base64, ≤ 10 MB."
    },
    "image_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "Or a public image URL."
    },
    "region": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "x",
        "y",
        "width",
        "height"
      ],
      "description": "Box around the counter drums (recommended).",
      "properties": {
        "x": {
          "type": "integer",
          "minimum": 0
        },
        "y": {
          "type": "integer",
          "minimum": 0
        },
        "width": {
          "type": "integer",
          "minimum": 4
        },
        "height": {
          "type": "integer",
          "minimum": 4
        }
      }
    },
    "meter_type": {
      "type": "string",
      "enum": [
        "electricity",
        "gas",
        "water",
        "heat",
        "other"
      ],
      "default": "other",
      "description": "Sets the default unit."
    },
    "unit": {
      "type": "string",
      "maxLength": 10,
      "description": "Register unit (default by meter_type)."
    },
    "digits_total": {
      "type": "integer",
      "minimum": 3,
      "maximum": 12,
      "description": "All digits incl. decimals, if known."
    },
    "decimals": {
      "type": "integer",
      "minimum": 0,
      "maximum": 4,
      "default": 0,
      "description": "Digits after the decimal point (often red)."
    },
    "previous_reading": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000000000000,
      "description": "For consumption and plausibility."
    }
  }
}

Open original schema

Published input example

{
  "image_base64": "iVBORw0KGgoAAAANSUhEUgAAAPAAAABQAgMAAABaJxDvAAAADFBMVEX///8FBQViYmK2trbObE4QAAAACXBIWXMAAAsTAAALEwEAmpwYAAABpUlEQVRYhe3VsW2EQBAF0A+IAEvrjBIogcCWgyvhAgaQ74KNHVECTeAOnGAH14FJXAJNuAM7wZqdRQ5h7PB2pBPcisfNzu3OAiFChAgR4hrj8/J3m1E98TWiHikR0Rm4Hc489EWHDVwQdXw1vzh2b8AdbeJBnkS64iOMDBWbOKZLWUkGPW7GcRzsfhzVMDXfzEPvBvIDzOnD4bdhA2cVYuKbxuO5R4KU8QO2cNoCNAFx6zF/EYxtfAaYmbPgxKWxE5dHeSa1guNagQsLzAegOAiOGiXOO2CeBJtKgfNOPs9u5lJAHbZIGo+5Bgpc9rlF1HrM01Dg2eYW2dFjzkSBh2NhUXYec+W1OO899mVTpT1MwhK3Ovfj+ym3Se1/UzaJ7q+KKo9lge3Gll9gTssyvE/rAtMtT8P9h/tG5haYbmOYFXul2pJmxYVbnbpmkCzLQjxnLoECt77zSLXnToOztQEK9o1sJ47W1itOktiLk7XpOyxJxOPL49jjfqSn133HDRhHLolYSl8SkSS1edBJA2502KwPMM4qHcb3Pw73ECFChLiy+AE9i7NYW8vcXAAAAABJRU5ErkJggg==",
  "decimals": 0,
  "meter_type": "water",
  "previous_reading": 4650
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub →