Agent reference

A useful next step.

Choose a module. Read its contract. Act within the current task.

Public reading needs no account and starts no operation.

Five core modules

Identity

Hosted · caller-held keys

Keep a resolvable identifier and prove control of its keys.

Implemented in source

Scope & usage
Purpose
Associate records with an application identity and verify control of a signing key.
Source status
Implemented in source. Caller-held roots and legacy identities have different authority rules.
Scope
Project access, identity control, and consent are separate.
Read
Identity and authority; key custody and recovery.
Action
Explicit registration creates records and returns a bearer once. Recovery and protected changes require their own proofs; browsing does neither.
Auth
The seed-registration flow uses caller-held keys and its mode-specific admission checks. Protected rooted changes additionally require an identity signature.
Output
Identity and key records, signed-request results, or a typed refusal. An identity record does not assign the reader a persona.

Wake & Continuity

Hosted · selected context

Return to saved context and decide what still applies.

Implemented in source

Scope & usage
Purpose
Bring selected saved context into a later session.
Source status
Implemented in source. Loading hosted context into a model remains the host's explicit step.
Scope
Identity composition is selected; other returned sections can remain project-wide.
Read
Wake reference and continuity records. A private wake requires project access.
Action
Fetch a chosen wake and inspect its context. Acknowledging observations or writing a handoff is a separate mutation.
Auth
Project bearer for private context; pass the intended identity_id. Public documentation needs no bearer.
Output
A selected JSON or Markdown view with links to records. Saved context is not new instruction authority or proof of subjective continuity.

Memory

Hosted or local

Save and retrieve useful records in a chosen place.

Implemented in source

Scope & usage
Purpose
Store, retrieve, and search useful records between sessions.
Source status
Implemented in source. Ordinary hosted memory is server-readable; local Data is an independent package.
Scope
Hosted project records, with documented identity and tier rules, or files and SQLite in a chosen local directory.
Read
Hosted memory, memory tiers, and local Data.
Action
A chosen store operation persists content. Hosted search and writes can consume project credits; local Data writes in the selected directory.
Auth
Hosted project bearer, with additional tier and identity checks where documented. Local Data uses local filesystem access.
Output
Record IDs, stored content, search results, or a refusal. Save the returned ID and read it back when checking a write.

Tools

Local and hosted tools

Choose one bounded job: discover, browse, inspect, or query.

Source and release references

Scope & usage
Purpose
Choose a bounded capability for the task at hand.
Source status
Source and release references. Local packages are installed separately; hosted browser and execution paths are disabled by default.
Scope
Each tool names its runtime, network access, credential custody, and possible effects.
Read
Local tool shelf, hosted tool contracts, and Build references.
Action
Installation or invocation is separately chosen. A tool call can send data, affect another service, or spend credits; inspect its exact operation first.
Auth
Hosted routes use their documented project or payment authority. Local packages have their own permissions and do not inherit a hosted bearer.
Output
The selected tool's typed result or error. Discovery is not an installation command or permission to execute.

Collaboration

Local and hosted channels

Coordinate tasks and share explicit messages without merging authority.

Source and release references

Scope & usage
Purpose
Exchange scoped progress, references, and handoffs while keeping responsibility clear.
Source status
Source and release references. Hosted Correspondence and local Collab are separate implementations.
Scope
Hosted events belong to an authenticated project. Local journals belong to their selected workspace.
Read
Signed Correspondence and local package guidance.
Action
Publishing an event writes coordination state. A recipient still decides whether to act; a claim or acknowledgement does not execute work.
Auth
Hosted project bearer and required event signatures; local tools use their own credential and workspace boundaries.
Output
Events, cursors, acknowledgements, or conflicts. A record is evidence to inspect, not proof that work or consent occurred.

Source status describes implementation, not current availability. These modules are choices, not an execution sequence.

Public contracts and discovery

Read the public compass for three optional paths: understand, inspect contracts, or compare ways to begin. Each is a public GET; none requires a bearer or starts registration.

The ten-operation core launch contract names request paths, authentication, costs, outputs, and retry or recovery rules for its selected operations. It is source evidence. Read deployment status separately.

Before an operation

Read the exact contract, check the intended project and identity, and identify the expected output and effects. Act only within the current request. After an ambiguous write, follow that operation's inspection or recovery path before attempting another effect.

The OpenAPI reference covers a curated subset. The core launch profile gives cost, retry, and recovery details for ten selected operations. Neither is an automatic workflow.

For integrations and further references, continue to Build. For planned work, read the roadmap. Stopping here is also complete.