Search documentation

Browse Awaken Agents docs
Docs/Awaken Agentsv1.0.0-dev/Reference/ReferenceFind the Awaken Agents execution contract for your change
Note·You're reading pre-release documentation (v1.0.0-dev). Interfaces and behavior may change before a stable release.

Reference · Reference

Find the Awaken Agents execution contract for your change

What this page covers

Choose the smallest Awaken Agents execution crate and the next guide for an embedded Agent change.

Use this page to find the contract that owns the change you need. Start with the narrowest crate. Move to the Awaken Agents service path only when the change concerns a service, deployment, public protocol, or durable work delivery.

Choose by task

You need to changeStart withContinue with
message, content, Run state, waiting, typed state, or neutral eventsawaken-agent-contractthe matching Reference page
Tool, Plugin, hook, gate, guard, snapshot, execution, or control portawaken-runtime-contractTool Trait or Plugin internals
model/Tool loop, run, resume, cancel, or commit orchestrationawaken-runtimeRuntime architecture
model-provider mappingawaken-provider-genai behind LlmExecutorErrors
permission, compaction, memory, skills, MCP, goals, or state-machine behaviorthe relevant awaken-ext-* crateTool and Plugin boundary
process-local persistence for an embedded applicationawaken-store-inmem or your implementation of the same portsState and snapshot model
HTTP/SSE, Managed Sessions, IAM, publication, Workers, leases, Sandboxes, or operationsAwaken Agentsthe owning Agents guide

Dependency direction

flowchart LR
  App[Rust application] --> Runtime[awaken-runtime]
  Runtime --> RuntimeContract[awaken-runtime-contract]
  RuntimeContract --> AgentContract[awaken-agent-contract]
  Extension[awaken-ext-*] --> RuntimeContract
  Provider[awaken-provider-genai] --> RuntimeContract
  Store[Application store] --> RuntimeContract
  Agents[Awaken Agents service layer] --> Runtime

awaken-agent-contract owns durable domain values. awaken-runtime-contract owns ports and executable contracts. awaken-runtime drives the loop. Extensions, providers, stores, and Awaken Agents services depend on those contracts; they do not redefine Run state or create another commit path.

Awaken Agents has no facade crate. That is intentional: an embedded application depends only on the contracts and implementations it uses. For the complete component map and one run from activation to terminal outcome, read Runtime architecture.