API Design

API Design is a skill for Claude Code, Codex from sergei-aronsen/claude-code-toolkit. It costs 32 tokens per session (1,721 once invoked), scanned A, original, MIT.

A guide to designing REST APIs, which are web interfaces organized around resources and HTTP requests. It covers names, response codes, error messages, OpenAPI documentation, and versioning.

In plain words
What is it for?
Use it when designing endpoints, choosing resource paths and status codes, writing API errors, or documenting an API with OpenAPI or Swagger.
Why use it?
It helps keep endpoints predictable and consistent, so developers and clients can understand how an API behaves.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it when designing endpoints, choosing resource paths and status codes, writing API errors, or documenting an API with OpenAPI or Swagger.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/sergei-aronsen/claude-code-toolkit/api-design
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add sergei-aronsen/claude-code-toolkit --skill api-design
Clone the repo
git clone --depth 1 https://github.com/sergei-aronsen/claude-code-toolkit

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for API Design

README.md
[![agentmods](https://agentmods.dev/badge/skills/sergei-aronsen/claude-code-toolkit/api-design/github.svg)](https://agentmods.dev/skills/sergei-aronsen/claude-code-toolkit/api-design)
Your own site
<a href="https://agentmods.dev/skills/sergei-aronsen/claude-code-toolkit/api-design"><img src="https://agentmods.dev/badge/skills/sergei-aronsen/claude-code-toolkit/api-design/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for API Design

Your own site · 80×15
<a href="https://agentmods.dev/skills/sergei-aronsen/claude-code-toolkit/api-design"><img src="https://agentmods.dev/badge/skills/sergei-aronsen/claude-code-toolkit/api-design.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 32 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,721 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00032 $0.01721
Opus 5.5 $0.00013 $0.00688
Sonnet 5.5 $0.00006 $0.00344
Haiku 4.5 $0.00003 $0.00172

Measured 1mo ago against content hash 712828b80d35, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

API Design scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

templates/base/skills/api-design/SKILL.md · 356 lines

How it starts

The opening of the file, as written. The whole thing — 356 lines — stays where its author put it; the contents beside it link to each section on GitHub.

API Design Skill

Load this skill when designing REST APIs, creating endpoints, or working with OpenAPI.


Rule

DESIGN CONSISTENT, PREDICTABLE APIs!

  • Use nouns for resources, HTTP verbs for actions
  • Return appropriate status codes
  • Provide clear error messages

REST Naming Conventions

Resources (nouns, plural)

GET    /users           # List users
POST   /users           # Create user
GET    /users/{id}      # Get user
PUT    /users/{id}      # Replace user
PATCH  /users/{id}      # Update user
DELETE /users/{id}      # Delete user

Nested Resources

GET    /users/{id}/posts        # User's posts
POST   /users/{id}/posts        # Create post for user
GET    /users/{id}/posts/{pid}  # Specific post

Actions (when CRUD doesn't fit)

POST   /users/{id}/activate     # Custom action
POST   /orders/{id}/cancel      # Custom action
POST   /reports/generate        # Non-resource action

HTTP Status Codes

Success (2xx)

Code When to Use
200 OK GET success, PUT/PATCH success
201 Created POST created new resource
204 No Content DELETE success, no body

Client Errors (4xx)

Code When to Use
400 Bad Request Invalid input/syntax
401 Unauthorized Not authenticated
403 Forbidden Authenticated but not allowed
404 Not Found Resource doesn't exist
409 Conflict Resource conflict (duplicate)
422 Unprocessable Entity Validation failed
429 Too Many Requests Rate limit exceeded

Server Errors (5xx)

Code When to Use
500 Internal Server Error Unexpected error
502 Bad Gateway Upstream service failed
503 Service Unavailable Temporarily unavailable

Error Response Format (RFC 7807)

{
  "type": "https://api.example.com/errors/validation",
  "title": "Validation Error",
  "status": 422,
  "detail": "The request body contains invalid fields",
  "instance": "/users/123",
  "errors": [
    {
      "field": "email",
      "message": "Invalid email format"
    },
    {
      "field": "age",
      "message": "Must be a positive number"
    }
  ]
}

Read the full file on GitHub · 356 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago First seen · 356 lines · 32 tokens per session scan A 712828b80d35

Subscribe to this mod's changes

API Design is a skill published in the GitHub repository sergei-aronsen/claude-code-toolkit (5 stars, last pushed 2mo ago), licensed MIT. It adds 32 tokens to every session and 1,721 once invoked, about $0.0001 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

mem0-oss-to-platform

Plan, then execute, a migration of a project from the mem0 open-source / self-hosted SDK (local Memory class) to the mem0 Platform / hosted SDK (MemoryClient). TRIGGER when: the developer wants to move, switch, or migrate mem0 off OSS/self-hosted to the hosted API, e.g. "migrate my mem0 setup to the platform", "switch…

mem0ai/mem0 · 217 tokens

agui-dotnet-protobuf

Use the protobuf wire transport (instead of the default Server-Sent Events) for an AG-UI connection with the AG-UI .NET SDK — a compact binary event stream negotiated via the Accept header. USE FOR: making an AGUIChatClient prefer protobuf by wiring an AGUIEventStreamHandler with ProtobufEventStreamFormatter (then…

ag-ui-protocol/ag-ui · 162 tokens

azure-mgmt-botservice-dotnet

Azure Resource Manager SDK for Bot Service in .NET. Management plane operations for creating and managing Azure Bot resources, channels (Teams, DirectLine, Slack), and connection settings. Triggers: "Bot Service", "BotResource", "Azure Bot", "DirectLine channel", "Teams channel", "bot management .NET", "create bot".

microsoft/skills · 78 tokens

fastapi-router-py

Create FastAPI routers with CRUD operations, authentication dependencies, and proper response models. Use when building REST API endpoints, creating new routes, implementing CRUD operations, or adding authenticated endpoints in FastAPI applications.

microsoft/skills · 46 tokens

dev-runtime

How the Node side of a dev stack runs without haven, and the backend host: pnpm dev (UI built once, backend reloading), pnpm dev:hmr (adds the Vite ui lane), tools/dev-runtime (api + worker in one Node process), backend reload on a file change, the debounce (quiet window + max wait), ports derived from PORT. Use when…

langwatch/langwatch · 172 tokens

api-design

Use when settling the contract of an API you expose, before implementation: resources/URLs, REST vs GraphQL, versioning, one RFC 9457 error envelope, pagination, idempotency — emitted as OpenAPI 3.1. NOT implementing the endpoints (that is fastapi/nestjs/go/nodejs), NOT auth hardening (that is secure-coding), NOT…

ericrisco/rsc-harness · 105 tokens