Documentation home

Install

Install HaltState SDKs and prepare a safe environment for guarded service or worker execution.

Python

python3 -m venv .venv
source .venv/bin/activate
pip install haltstate-sdk

TypeScript

npm install @haltstate/sdk
# or use direct HTTP guard calls until the package version you need is published

Service checklist

  • Run workers with least-privilege API keys.
  • Set fail-closed behavior for money, PII, and production writes.
  • Use a stable idempotency key before the first guard call.
  • Report execution only after the side effect has completed.
  • Keep raw customer payloads out of public live events.

Implementation notes

Keep the HaltState call as close as possible to the side effect. The agent may plan and draft freely, but the wrapper around the actual action should be the place where authority is checked. That wrapper should send only the context required for policy evaluation: safe identifiers, normalized amounts, action names, risk flags, schedule windows, and redaction status. Raw customer payloads and secrets should stay in the business system or protected operator tooling.

Operational evidence

For each action, preserve the decision, the worker outcome, the idempotency key, safe resource references, latency, proof status, and redaction status. This evidence supports incident response and control narratives because it shows what the system did at runtime rather than only describing what the policy document intended. HaltState supports alignment work; it is not a substitute for legal advice or a compliance certification.