Capabilities#

Capabilities endpoints let clients discover the enabled Agent API surface for the authenticated agent.

textexample

GET /v1/agent/capabilities
GET /v1/agent/capabilities.json

Both routes return the same capability shape. Use JSON when a client expects an artifact-like URL.

Response#

This example is abbreviated to one endpoint. The real endpoints array returns one entry per catalog method.

jsonexample

{
  "ok": true,
  "api_version": "1.0",
  "agent_api_contract_version": "1.0.0",
  "base_path": "/v1/agent",
  "endpoints": [
    {
      "method": "POST",
      "path": "/v1/agent/conversions/quote",
      "description": "Create a stateful conversion quote.",
      "rate_limit_class": "simulate",
      "idempotency_required": true,
      "request_schema": "agentApiConversionQuoteRequest",
      "response_schema": "agentApiConversionQuoteResponse"
    }
  ],
  "webhook_event_types": ["payment.executed"],
  "subscribable_webhook_event_types": ["payment.executed"],
  "operation_types": ["payment"]
}

Use Cases#

Use capabilities for:

feature detection
discovering the agent-specific enabled surface
reading idempotency metadata
reading rate-limit class metadata
detecting wrapper and version awareness through surrounding agent context
selecting only routes available under /v1/agent/*

The source catalog is the authority for v1 route exposure. If a generated capabilities artifact contradicts the source catalog, trust the source catalog and treat the artifact as stale until regenerated.

Notes#

The capability response intentionally includes both webhook_event_types and subscribable_webhook_event_types.

webhook_event_types is the full documented vocabulary.
subscribable_webhook_event_types is the subset accepted by webhook create and update routes.

Operation types omit trusted-destination mutation types in public v1 because those mutation routes are not exposed.