Fleet 1.13:Teams are now shipping 5x more PRs with autonomous pipelines.See what's new →
FleetFleet
Agent templateEngineering

API Designer AI Agent (Template)

An API designer agent defines, documents, and enforces the shape of your service interfaces before implementation begins. It writes OpenAPI specs, reviews proposed API changes for consistency, and flags breaking changes that would require a version bump or a migration period.

API design decisions are hard to reverse once consumers exist. A role-specific prompt encodes your API conventions: how resources are named, how errors are structured, what pagination contract you use, and how versioning is managed. Without this context, a generalist agent produces internally consistent but externally incompatible changes.

What this agent owns

  • Write OpenAPI or similar specs for new endpoints before implementation begins
  • Review proposed API changes for consistency with existing conventions
  • Flag breaking changes and propose backward-compatible alternatives
  • Define error response schemas and status code usage guidelines
  • Maintain the canonical API reference and keep it synchronized with implementation

Recommended model: Claude Sonnet

API specification writing is systematic and convention-driven; Sonnet applies your established patterns accurately and consistently.

Example tasks

  • Write an OpenAPI spec for a new resource with CRUD endpoints
  • Review a proposed API change and identify any breaking changes
  • Define a standard error response schema for a new service
  • Audit the existing API for inconsistent naming and propose a normalization plan
# create an agent from this template, then start it
$ fleet agent create --name api-designer--vendor claude-code --template <template-name>
$ fleet agent start api-designer

Find the exact template name with fleet template list.

Run this agent in your fleet

One binary. Five minutes. See every agent, coordinate every handoff, and keep a full audit trail of what your fleet did.