Install

Python

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

TypeScript

npm install @haltstate/sdk

Go

Stable baseline: v1.0.1. The recording and Semiotic Probe release is v1.1.0-dev.1, published on GitHub and verified through the Go module proxy.

go get github.com/haltstate-ai/sdk-go@v1.1.0-dev.1

Install this published release explicitly to use recording and Semiotic Probes. Existing integrations remain on the Standard contract unless enrolled for replay. Semiotic Probes use an isolated model hook, your existing tenant API key and the server-managed low-frequency schedule.

Java

The recording and Semiotic Probe release is published on GitHub at v0.3.0-dev.1. Use Java 17 or later and install from JitPack with the version below.

repositories { mavenCentral(); maven { url = uri("https://jitpack.io") } }
dependencies { implementation("com.github.haltstate-ai:sdk-java:v0.3.0-dev.1") }

Install this published release explicitly to use recording and Semiotic Probes. Existing integrations remain on the Standard contract unless enrolled for replay. Semiotic Probes use an isolated model hook, your existing tenant API key and the server-managed low-frequency schedule.

Rust

Install the recording and Semiotic Probe release directly from GitHub using this Cargo dependency:

haltstate = { git = "https://github.com/haltstate-ai/sdk-rust", tag = "v0.2.0-dev.1" }

Use this published Git tag as a Cargo dependency; no crates.io account is required.

Install this published release explicitly to use recording and Semiotic Probes. Existing integrations remain on the Standard contract unless enrolled for replay. Semiotic Probes use an isolated model hook, your existing tenant API key and the server-managed low-frequency schedule.

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.

SDK availability

All five SDKs are available. Select the documented release for the features you need; development-version releases are installed explicitly. The additional TypeScript recording helpers are not in the published 2.0.0-dev.0 release. Installing an SDK does not change your workspace's runtime contract. Existing integrations continue to use the Standard contract; replay-enabled integrations use the configured replay contract.

Canonical API base

New integrations should use https://haltstate.ai as the public base URL and the HaltState-branded governance namespace. Existing clients may still support compatibility aliases, but public docs point new users at the current contract.

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.