Skip to content

Getting Started

Install

pip install hgateway-sdk==0.1.1

Configure

Settings are resolved from the process environment first; a .env file is consulted only if a required value is still missing. The gateway URL and register endpoint are fixed — every agent talks to the same theved.ai hgateway service, so they are not configurable.

Variable Required Default
HGATEWAY_AGENT_API_KEY yes
HGATEWAY_TIMEOUT_SECONDS no 5

A missing required value raises GatewayBootstrapError.

Next

Head to the Integration Guide for the step-by-step: decorate your node, build a typed interrupt, raise it, and handle the resume in your own backend. For how that resume actually gets back to you (payloads, auth, retries), see Architecture & Lifecycle.