Skip to main content
subagent CX Codex

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

Install into Claude Code · Manually: put the files in place All methods and platforms ↓
.claude/agents/api_designer.md
Open on GitHub

What 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.md

For all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention

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.

Similar subagents

All subagents for Backend and APIs →

From the same set24

The whole set →
security_auditor security_auditor — a subagent for Claude Code runs defensive application security reviews. Inspects source code, configurations, and dependency scanner logs to report exploitable flaws. CX Codex ★ 776repo stars search_specialist The search_specialist Claude Code subagent turns an information need into focused queries and assesses retrieved sources. It returns a compact evidence set in JSON for downstream work. CX Codex ★ 776repo stars data_engineer The data_engineer Claude Code subagent designs batch and streaming data pipelines from stated requirements. It returns a Markdown specification covering data flow, quality checks, and operations. CX Codex ★ 776repo stars product_manager product_manager is a Claude Code subagent that turns a product question and available evidence into a clear decision. It helps compare options, set priorities, and define how to measure results. CX Codex ★ 776repo stars database_optimizer database_optimizer — a subagent for Claude Code, Codex, and Cursor reviews database performance evidence and proposes optimizations. It ranks bottlenecks and outlines how to measure proposed changes. CX Codex ★ 776repo stars fullstack_implementation_engineer The fullstack_implementation_engineer Claude Code subagent turns an approved feature spec into a coordinated implementation plan. It covers data, APIs, business logic, UI, migrations, and tests. CX Codex ★ 776repo stars devops_incident_responder The devops_incident_responder Claude Code subagent turns production incident details into a diagnosis and recovery plan. It can use logs, metrics, and deployment history when provided. CX Codex ★ 776repo stars backend_architecture_expert The backend_architecture_expert Claude Code subagent turns repository context and requirements into a backend architecture specification. It is activated for proposed changes to APIs, data, and services. CX Codex ★ 776repo stars

Project sponsors

Companies that keep this analytics open