Technical reference
Look up exact names, values, types, and permissions here. To learn a workflow, start with the product map or tutorials.
Find the contract you need
Section titled “Find the contract you need”| I need to… | Reference |
|---|---|
| Integrate with the Agent or inspect method families | Agent API |
| See what runs as You or as an Agent, and the roles each needs | Operations and capabilities |
| Construct a link to a canister, Agent, dashboard, or query | Routes and navigation |
| Interpret a failure and choose a recovery action | Errors and recovery |
| Discover metric names, identity, units, and query semantics | Signals and metrics |
| Integrate instrumentation or understand SDK transport | SDK APIs |
| Understand persisted data and accepted import formats | Workspace, storage, and schemas |
| Look up funding availability, deductions, and limits | Product policy |
| Understand origins, configuration, and release inputs | Configuration and release environment |
| See how the Agent stores and queries metrics | Metrics engine |
| See what changed in each release | Release notes |
Current downloadable contracts
Section titled “Current downloadable contracts”- Agent Candid interface: exact method arguments, result types, and variants.
- Generated TypeScript declarations: the types derived from that interface.
- Product policy JSON: current feature policy, limits, revision, and source hash.
These files describe the checkout used to build the docs. They provide no credentials, runtime discovery, or authority over a deployed Agent.
Reading the API
Section titled “Reading the API”Use Candid to establish the method shape, then read the domain guide for caller authority, effects, and recovery. A method that gathers live management data can be an update call even though its purpose is inspection. A returned receipt may describe an accepted job rather than a completed external effect.