api-design

api-design is a skill for Claude Code, Codex from KbWen/agent-virtual-office. It costs 17 tokens per session (1,023 once invoked), scanned A, a copy of api-design, MIT.

A workflow for designing or reviewing REST and GraphQL APIs, which are conventions for exposing application data and actions over a network.

In plain words
What is it for?
Use it when creating, modifying, or deprecating API endpoints during implementation, review, or contract testing. It covers resource paths, request actions, success codes, and standard error shapes.
Why use it?
It provides consistent endpoint naming, HTTP methods, status codes, and error responses when an API contract changes.

Skill for Claude CodeCodex

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.

agentmods
npx agentmods add skills/kbwen/agent-virtual-office/api-design
Any agent
npx skills add KbWen/agent-virtual-office --skill api-design
Clone the repo
git clone --depth 1 https://github.com/KbWen/agent-virtual-office

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/kbwen/agent-virtual-office/api-design.svg)](https://agentmods.dev/skills/kbwen/agent-virtual-office/api-design)
Your own site
<a href="https://agentmods.dev/skills/kbwen/agent-virtual-office/api-design"><img src="https://agentmods.dev/badge/skills/kbwen/agent-virtual-office/api-design.svg" alt="Measured on agentmods" height="20"></a>
Per session 17 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,023 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% copy Near-identical to another mod 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 $0.00017 $0.01023
Opus 5 $0.00009 $0.00511
Sonnet 5 $0.00003 $0.00205
Haiku 4.5 $0.00002 $0.00102

Measured 4d ago against content hash 3bb02b810098, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, 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 4d 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.

Origin

This is a copy

100% identical to api-design — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

.agents/skills/api-design/SKILL.md · 127 lines

How it starts

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

API Design

When to Apply

  • Classification: feature, architecture-change, hotfix (if touching API endpoints)
  • Phase: /implement (design & build), /review (compliance check), /test (contract verification)
  • Trigger: Task involves creating, modifying, or deprecating API endpoints

Conventions

Customize after /app-init: Replace these generic conventions with your project's ADR decisions.

Endpoint Naming

  • Use nouns for resources, not verbs: GET /users not GET /getUsers
  • Plural resource names: /users, /orders, /products
  • Nested resources for relationships: /users/:id/orders
  • Use kebab-case for multi-word paths: /order-items

HTTP Methods

Action Method Success Status Idempotent
List GET 200 Yes
Get one GET 200 Yes
Create POST 201 No
Full update PUT 200 Yes
Partial update PATCH 200 No
Delete DELETE 204 Yes

Error Response Format

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Email is required",
    "details": {
      "field": "email",
      "constraint": "required"
    }
  }
}

Standard Error Codes

HTTP Status When Error Code Pattern
400 Invalid input VALIDATION_ERROR, INVALID_FORMAT
401 Not authenticated UNAUTHORIZED
403 Not permitted FORBIDDEN
404 Resource not found NOT_FOUND
409 Conflict (duplicate) CONFLICT, DUPLICATE
422 Business rule violation UNPROCESSABLE
429 Rate limited RATE_LIMITED
500 Server error INTERNAL_ERROR

Pagination

{
  "data": [...],
  "pagination": {
    "total": 100,
    "page": 1,
    "per_page": 20,
    "has_next": true
  }
}

Versioning

  • URL path versioning: /api/v1/users
  • Breaking changes require new version
  • Deprecation: add Sunset header with date, keep old version for N months

Input Validation

  • Validate at the controller/route level BEFORE business logic
  • Return ALL validation errors at once (batch), not one at a time
  • Sanitize strings: trim whitespace, escape HTML where applicable
  • Enforce max lengths on all string fields

Read the full file on GitHub · 127 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 4d ago First seen · 127 lines · 17 tokens per session scan A 3bb02b810098

Subscribe to this mod's changes

api-design is a skill published in the GitHub repository KbWen/agent-virtual-office (16 stars, last pushed 2d ago), licensed MIT. It adds 17 tokens to every session and 1,023 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to api-design, differing in 0 lines, and is treated as a copy.