Documentation

Ship agents with a clear contract.

Blueprints, Run API, widgets, callbacks, and optional Zenith route-lease — the operator surface explained with live diagrams and copy-paste terminals.

HTTP

Run API

Authenticate with a tenant API key. Create sync or async runs against a published agent — the same contract the console and widget use.

Auth Send Authorization: Bearer <api_key> or X-API-Key. Keys are hashed at rest; plaintext is only shown once at mint.

Create a run

POST a published agent_id and input. Soft quota limits return HTTP 402 when the plan is exhausted.

POST /api/v1/runs
$ curl -sS -X POST "http://127.0.0.1:8090/api/v1/runs" \
  -H "Authorization: Bearer $AGENTICARIA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"agent_id":"agt_…","input":"search docs about publish"}'

Stream tokens

Use SSE for interactive UIs. Events include token, tool, and complete.

POST /api/v1/runs/stream
$ curl -N -X POST "http://127.0.0.1:8090/api/v1/runs/stream" \
  -H "Authorization: Bearer $KEY" \
  -H "Accept: text/event-stream" \
  -d '{"agent_id":"agt_…","input":"…"}'

Parity snapshot

After a run succeeds, pull evidence for staging checks — artifact hash, lease id, and tool receipts.

GET /api/v1/runs/{id}/parity
$ curl -sS "http://127.0.0.1:8090/api/v1/runs/$ID/parity?label=staging" \
  -H "Authorization: Bearer $KEY"