Skip to content

API Overview

Base path: /agents/v1

The API provides read/sync surfaces plus governed control-plane actions.

Runtime trust boundary:

  • production actions flow through scoped HTTP APIs and policy gates
  • plugin runtime does not execute agent shell commands
  • CLI commands are operator/developer tools (craft agents/*)

Discovery descriptors

  • GET /agents/v1/capabilities
  • GET /agents/v1/openapi.json
  • GET /agents/v1/auth/whoami
  • aliases: GET /capabilities, GET /openapi.json

These describe available endpoints, scopes, auth posture, and error taxonomy for integration clients.

Public discovery files

  • GET /llms.txt
  • GET /llms-full.txt
  • GET /commerce.txt

These are root-level and public when enabled.

Agent-focused Markdown handbook:

Endpoint classes

  • read endpoints (health/readiness/auth/adoption/metrics/diagnostics/products/variants/subscriptions/transfers/donations/orders/entries/assets/categories/tags/global-sets/addresses/content-blocks/users/changes/sections)
  • integration state endpoints (/sync-state/*, /templates, /starter-packs, /schema, /lifecycle)
  • webhook operations (/webhooks/dlq, /webhooks/dlq/replay)
  • control endpoints (/control/*) when experimental flag is enabled
  • list projection/filtering on key list endpoints via fields and filter query params

See:

Agents plugin docs for Craft CMS