Getting Started/Response shape

Response shape

Every response — successful or not — follows the same envelope. Agents can rely on the same fields being present without per-endpoint adapters.

{
  "success": true,
  "action_performed": "create_blog",
  "summary": "Blog \"My Blog\" created.",
  "affected_resources": {
    "feather_blog_url": "https://abcdefgh.feather.blog",
    "blog_live_notice": "Give it about 2 minutes; the blog will be live on that URL."
  },
  "next_possible_actions": ["GET /actions"]
}

Fields

success

booleanRequired

Whether the call succeeded. false means an error envelope follows — see Errors & rate limits.

action_performed

stringRequired

What was done, in snake_case. Mirrors the action id from /actions.

summary

stringRequired

A plain-English description suitable for surfacing directly to an end user or agent.

affected_resources

objectRequired

Key/value pairs describing what was created or changed. Shape is action-specific. Empty object on calls that produce no side effects.

next_possible_actions

string[]Required

Route strings ("GET /actions", "POST /v1/blog/create") the agent might consider as follow-up calls. Ordered by relevance.