api-design

api-design is a skill for Claude Code, Codex from kouroshez/coding-os. It costs 84 tokens per session (2,928 once invoked), scanned A, original, Apache-2.0.

A guide to designing HTTP APIs, which let software exchange requests and data, using REST or GraphQL. It focuses on clear contracts, meaning the documented rules clients rely on, and on changing those rules without breaking existing users.

In plain words
What is it for?
Use it when adding or reviewing an endpoint or OpenAPI/GraphQL schema, choosing REST versus GraphQL, planning versions, designing pagination or idempotency keys, or mapping application errors to HTTP responses.
Why use it?
It reduces surprises for teams and applications that depend on an API. It helps prevent breaking changes and gives consistent approaches to errors, pagination, retries, and repeated requests.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: positional $N argument.

Good fit Use it when adding or reviewing an endpoint or OpenAPI/GraphQL schema, choosing REST versus GraphQL, planning versions, designing pagination or idempotency keys, or mapping application errors to HTTP responses.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/kouroshez/coding-os/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 kouroshez/coding-os --skill api-design
Clone the repo
git clone --depth 1 https://github.com/kouroshez/coding-os

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/kouroshez/coding-os/api-design/github.svg)](https://agentmods.dev/skills/kouroshez/coding-os/api-design)
Your own site
<a href="https://agentmods.dev/skills/kouroshez/coding-os/api-design"><img src="https://agentmods.dev/badge/skills/kouroshez/coding-os/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/kouroshez/coding-os/api-design"><img src="https://agentmods.dev/badge/skills/kouroshez/coding-os/api-design.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 84 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,928 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.00084 $0.02928
Opus 5.5 $0.00034 $0.01171
Sonnet 5.5 $0.00017 $0.00586
Haiku 4.5 $0.00008 $0.00293

Measured 1mo ago against content hash 02f66d3da7fb, 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.

src/core/skills/api-design/SKILL.md · 233 lines

How it starts

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

API Design — REST + GraphQL Contracts

A practical guide to designing APIs that consumers can build against without surprises. Stack-agnostic; concrete patterns target this project's stack (Go+Fiber for the business backend, Python+FastAPI for the AI adapter, React Native client).

When to Use This Skill

  • Adding the first endpoint to a service — the contract you ship now will outlive three implementations.
  • Reviewing an OpenAPI / GraphQL schema PR before merge.
  • Adding a v2 version of a live endpoint without breaking v1 clients.
  • Debating REST vs GraphQL for a new bounded context.
  • Designing pagination, idempotency, rate-limit responses, batch endpoints.
  • Mapping domain errors (from a use case in your hexagonal architecture) to HTTP responses.

Skip when: writing internal-only RPCs that have one caller and you control both sides — use whatever's fastest.

The Contract Is the Product

Three rules that override everything else:

  1. Consumers cannot read your code. They read the contract. If the contract is ambiguous, the consumer guesses wrong, and you find out in production.
  2. Breaking changes are expensive forever. Every consumer must coordinate. Plan as if you can't break things — because at scale, you can't.
  3. The use case shape is sacred. The API shape is negotiable. Don't bend domain operations to match HTTP idioms. Translate at the adapter boundary (per hexagonal-architecture).

REST vs GraphQL — Decision

Pick REST when:

  • Consumers are heterogeneous (mobile + web + 3rd-party). REST is the universal lingua franca.
  • Endpoints map cleanly to resources. CRUD-like dominates.
  • You need HTTP-native caching (CDN, proxies, conditional GET).
  • You want minimal client tooling (no codegen mandatory).

Pick GraphQL when:

  • Single consumer team or tightly-coupled clients (e.g. one mobile app + one web app from same team).
  • Heavy over-fetching with REST: clients pull 12 fields and use 2.
  • Frequent shape evolution that doesn't justify a v2 endpoint.
  • You're willing to invest in DataLoader, persisted queries, query complexity limits.

Read the full file on GitHub · 233 lines

Files

What ships with it

4 files 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. 1mo ago First seen · 233 lines · 84 tokens per session scan A 02f66d3da7fb

Subscribe to this mod's changes

api-design is a skill published in the GitHub repository kouroshez/coding-os (6 stars, last pushed 5d ago), licensed Apache-2.0. It adds 84 tokens to every session and 2,928 once invoked, about $0.0003 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

potpie-repo-baseline

Use when establishing, refreshing, or deeply understanding a repository's baseline memory in Potpie: purpose, application type, features, services/modules, environments, deploy shape, dependencies, API contracts, datastores, integrations, ownership, and explicit preferences. The harness reads authored and…

potpie-ai/potpie · 75 tokens

potpie-infra-architecture

Use for project infra and architecture context: environments, adapters, runtime configuration, deployments, service dependencies, datastores, API contracts, ownership, incidents, and dependency blast radius.

potpie-ai/potpie · 43 tokens

potpie-project-preferences

Use before writing, modifying, reviewing, refactoring, or testing code so repo/project preferences surface: error handling, file structure, frameworks, logging, dependency choices, testing, security, API style, and naming. Also use after code work when a reusable project preference should be recorded.

potpie-ai/potpie · 63 tokens

bi-causal-attribution

A business-analysis skill that links business events in reports, plans, release notes, or conversations with an unusual metric change. It produces and ranks possible causes supported by the available evidence.

agentscope-ai/QwenPaw-Data · 76 tokens

browser-2471a991

An HTTP request builder for assembling a GET request with a host and headers. HTTP is the standard format browsers and servers use to exchange web requests and responses.

FuRongJun-1999/dsh-memory · 90 tokens

browser-e947a564

An HTTP cache pattern using ETags, which are server-provided identifiers for a response version. The browser sends the ETag back to ask whether the resource has changed.

FuRongJun-1999/dsh-memory · 97 tokens