Overview

What the IGH home API is

The IGH home API shows and controls a Green Point home through an API integration: a record an administrator creates in the IGH app. The integration decides what is visible (everything, or selected floors, rooms, units and scenes) and what may be done (settings, renaming, automations, schedules, unlocking, agents, the cloud).

One model, two transports. The same /v1 paths answer on the gateway itself (home network, port 8490) and through the cloud relay at https://api.igh.app/v1. The WebSocket /v1/stream carries the same requests plus live events.
The gateway decides. Every request, local or relayed, from a script or an agent, is checked on the gateway against the stored integration. Anything not exposed answers 404 not_found, never "forbidden".
Every answer names the house (house), so a program or an agent connected to two homes never mixes them up.
Intents, not menus. Unit configuration is offered as plain-language intents (see Intents); values read from units come from the gateway's cache and never send a radio frame.
Agents connect through the MCP server at https://mcp.igh.app and are approved by an administrator with Accept agent (see Authentication and Accept agent and Agents).

Start with Getting started, then read GET /v1/house for the shape of a home.

Concepts

Integration (record). One API integration of one home. A home may have several (one per script or agent group). GET /v1/integration answers which one a credential belongs to, its house and its settings.

Exposure. What the integration shows: All (everything the API supports, including what is added later) or Selected (only what is picked; a picked floor or room includes what is moved into it later and drops what is moved out). Everything else does not exist for the integration.

Settings (knobs), read fresh on every request:

Knob	Values	What it allows
`advanced_config`	`off`, `read` (default), `read_write`	reading and changing intents
`structural`	`off` (default), `on`	renaming rooms and units
`automations`	`off` (default), `on`	automations
`schedules`	`off` (default), `on`	gateway schedules; the units' own schedules read from cache
`agent_access`	`off` (default), `on`	agent and session credentials
`cloud_access`	`on` (default), `off`	requests through `api.igh.app` and MCP
`mdns`	`on` (default), `off`	the `_igh-api._tcp` announcement on the home network
`allow_unlock`	`off` (default), `on`	unlocking and opening locks and gates

Device ids. {gateway}:{integration}:{unit} for a unit or module, {gateway}:{integration}:{unit}:{gang} for one gang, {gateway}:{integration}:scene:{scene} for a scene. Take them from GET /v1/house; never build them.

Units, modules and gangs. A Unit is one device. A multi-gang module (kind: "module") holds its Gangs and is controlled gang by gang; each gang may sit in its own room. A Scene is run with op: "run".

Operations. Each unit and gang lists the operations its class takes; POST /v1/devices/{id}/control accepts only those.

IGH home API 1.1.0. Generated from the doc source; do not edit.