API Reference
The product facade is the recommended public API surface. Use it before reaching for lower-level Runtime routes.
observe -> guide -> feedback -> measure -> snapshotProduct Endpoints
| Endpoint | Purpose | SDK method |
|---|---|---|
/v1/observe | Record ordinary memory and execution evidence | observe, remember, execution.observeStep |
/v1/guide | Compile governed Agent context | guide, execution.guideForRole |
/v1/feedback | Attribute outcome to exposed memory | feedback, execution.feedbackFromOutcome |
/v1/measure | Report product effect | measure, execution.measureRun |
/v1/operator/snapshot | Create operator snapshot | operatorSnapshot, snapshot, execution.snapshotRun |
/v1/memory/govern | Govern external backend memory | governMemory, governMem0SearchResults |
/v1/audit/flight-recorder | Replay an Agent decision | flightRecorder |
/v1/rehydrate | Expand archived or pointer-only evidence | rehydrate |
Shared Request Fields
| Field | Meaning |
|---|---|
tenant_id | Logical tenant. Local Lite commonly uses default. |
scope | Project, repo, workspace, or task boundary for recall and governance. |
actor | Human or service actor performing the request. |
consumer_agent_id | Agent that will consume a guide. |
consumer_team_id | Shared team lane for multi-agent memory. |
run_id | Execution run identifier. |
task_signature | Stable task or workflow identity. |
The most common integration bug is scope mismatch: observe writes into one scope, guide reads from another, and the host thinks memory is missing.
Agent Context Modes
| Mode | Use when |
|---|---|
compact_agent | You want bounded prompt text for an Agent. |
| full packet output | You are building an operator UI or debugger. |
The SDK defaults guide mode to full_power, then lets you request
context_mode: "compact_agent" for prompt-ready context.
Error Boundary
The product facade returns bounded error payloads and avoids leaking local store paths. Treat non-2xx as structured Runtime feedback rather than plain text.
Local Lite Boundary
The public package currently ships as a local-first Lite Runtime:
| Boundary | Current behavior |
|---|---|
| Auth | Local Lite defaults to auth off and loopback binding. |
| Multi-tenant service | Not the current product edition. |
| Storage | Local SQLite. |
| External memory | Supported through /v1/memory/govern as read-only candidates. |
For installation, start with Quickstart. For SDK usage, start with TypeScript SDK.