# api_designer

The api_designer Claude Code subagent turns product or service requirements into REST or GraphQL API contracts. It runs on API specification tasks.

- subagent · `type=agent` · Claude Code, Codex, Cursor · ★ 776 repo stars
- Author: AgenticOrgLab
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/AgenticOrgLab/ExecOrchestra/tree/HEAD/execorchestra/Pool/resources/agents/api_designer.md
- Updated: 2026-11-12
- Security check: automated, 2026-11-17 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/agents/agenticorglab-api-designer

## What it 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.

## Install

### Claude Code (native platform)

**Manually: put the files in place**
- File: `.claude/agents/api_designer.md` — For all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention

### Codex

**Manually: put the files in place**
- File: `.codex/agents/api_designer.toml` — Codex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/

### Cursor

**Manually: put the files in place**
- File: `.cursor/agents/api_designer.md` — Cursor also reads .claude/agents/

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/AgenticOrgLab/ExecOrchestra/tree/HEAD/execorchestra/Pool/resources/agents/api_designer.md

## When to use it
- 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
- 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.

## Similar
- [api-designer](https://affpapa.org/en/nevibecode/skills/api-designer.md) — skill · 7100 installs
- [API Designer](https://affpapa.org/en/nevibecode/skills/daffy0208-api-designer.md) — skill · 204 installs
- [technical-designer](https://affpapa.org/en/nevibecode/agents/technical-designer.md) — subagent · ★ 720 repo stars
- [schema-designer](https://affpapa.org/en/nevibecode/plugins/schema-designer.md) — plugin · ★ 2858 repo stars
- [ui-ux-designer](https://affpapa.org/en/nevibecode/agents/ui-ux-designer.md) — subagent · 27069 installs
- [api-and-interface-design](https://affpapa.org/en/nevibecode/skills/api-and-interface-design.md) — skill · 79800 installs

From the same set: [agenticorglab/execorchestra](https://affpapa.org/en/nevibecode/by/agenticorglab/execorchestra.md) — 24 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
