api_designer — Claude Code subagent: what it does and how to install
The api_designer Claude Code subagent turns product or service requirements into REST or GraphQL API contracts. It runs on API specification tasks.
no license ★ 776 updated 2026-11-12
.claude/agents/api_designer.mdWhat api_designer does
api_designer drafts an implementation-ready API contract from product and service requirements. It defines scope, consumers, and resources, then describes operations, request and response formats, errors, and pagination.
The contract covers authentication, authorization, idempotency, rate limits, and versioning. It also includes schema examples, lifecycle guidance, and ways to verify the contract. Required rules are kept separate from implementation suggestions.
Existing contracts stay intact unless a breaking change has been explicitly approved. Repository context, domain models, current endpoints, and schemas can be supplied as supporting information.
What it helps with
- turn API requirements into endpoint or operation definitions
- specify request, response, and error behavior
- set authentication and versioning rules
- define checks for an API contract
Example prompts for the agent
- Draft a REST API contract from the requirements in this project.
- Describe the GraphQL operations, schemas, and errors for this service.
- Write an API contract with authentication, pagination, and versioning rules.
How to install api_designer
Manually: put the files in place
.claude/agents/api_designer.mdFor all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention
Manually: put the files in place
.codex/agents/api_designer.tomlCodex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/
Manually: put the files in place
.cursor/agents/api_designer.mdCursor also reads .claude/agents/
Step by step, with commands for each platform: Claude Code subagents: how to create one, call it and keep context clean
Questions about api_designer
How do I install api_designer in Claude Code?
Add the subagent file at .claude/agents/api_designer.md.
What does api_designer do?
It creates a Markdown contract for a REST or GraphQL API from requirements and service context. The contract covers operations, schemas, and interaction rules.
Which API styles can api_designer describe?
It handles REST and GraphQL interfaces, including operation details, request and response formats, errors, and pagination.