Developer-facing documentation for Agents API, a WordPress-shaped substrate for agent registration, runtime contracts, channels, workflows, auth, memory, and related extension points.
New here? Read the Introduction first — it explains the core idea and the vocabulary the rest of these docs assume.
- Introduction - the one-sentence version, the three layers, the core vocabulary, and how a single request flows through the runtime. The on-ramp for anyone new to the concepts.
- Architecture - module inventory, bootstrap lifecycle, substrate boundary, extension principles, and operational workflow.
- Capability Map - reference mapping each capability an AI runtime needs to the substrate primitive that provides it, with contract locations.
- Registry and Packages - agent registration,
WP_Agent, package manifests, package artifacts, and artifact type registration. - Runtime and Tools - conversation loop, request/result objects, tool declarations, mediation, policies, budgets, compaction, and events.
- Auth, Consent, Context, and Memory - bearer-token auth, access grants, execution principals, consent decisions, memory/context registries, and guideline boundaries.
- Channels, Workflows, and Operations - direct channels, canonical chat payloads, bridge queues, workflows, routines, transcripts, approvals, and scheduling.
- External Clients, Channels, And Bridges - external conversation surfaces and bridge/channel integration shapes.
- Bridge Authorization And Onboarding - connector identity, bridge authorization dimensions, and onboarding boundary.
- Remote Bridge Protocol - queue-first remote bridge flow, storage, pending items, and acknowledgement semantics.
- Default Stores Companion Proposal - companion package boundary for guideline-backed memory, markdown memory, and transcript stores.
docs/
+-- README.md # This navigation index
+-- introduction.md # Concepts + vocabulary on-ramp for newcomers
+-- architecture.md # Substrate architecture and module inventory
+-- capability-map.md # Capability -> primitive reference map
+-- registry-and-packages.md # Agent and package registration contracts
+-- runtime-and-tools.md # Runtime loop and tool mediation contracts
+-- auth-consent-context-memory.md # Auth, consent, context, and memory contracts
+-- channels-workflows-operations.md # Channels, workflows, routines, transcripts, approvals
+-- external-clients.md # Existing external client architecture note
+-- bridge-authorization.md # Existing bridge authorization note
+-- remote-bridge-protocol.md # Existing remote bridge protocol note
+-- default-stores-companion.md # Existing default stores companion proposal
Agents API has one docs audience: developers integrating with or extending the substrate. Keep new documentation in this topic-oriented docs/ tree.
Primary source areas covered by this documentation:
agents-api.phpREADME.mdcomposer.jsonsrc/Registry/,src/Packages/,src/Runtime/,src/Tools/src/Auth/,src/Consent/,src/Context/,src/Memory/,src/Guidelines/src/Channels/,src/Workflows/,src/Routines/,src/Transcripts/,src/Approvals/
Representative smoke tests in composer.json cover registry, subagents, authorization, caller context, consent, context registry/authority, memory metadata, workspace scope, guidelines substrate, conversation loop, compaction, budgets, events, tool execution, policies, channels, remote bridge, webhook safety, workflows, routines, approvals, transcript locks, and product-boundary behavior.
The current topic pages document each major module family at integration-contract depth. Future updates should add focused reference pages when a module needs method-level or field-level detail, especially:
Approvals/pending action lifecycle and handler permission semantics.Guidelines/substrate internals beyond the memory/context boundary.Transcripts/store and lock contracts.Identity/materialization details.- Exhaustive field references for runtime value objects, workflow specs/results, bridge queue items, and Action Scheduler bridge hooks.