api-design

api-design is a skill for Claude Code, Codex from Pixel-Process-UG/superkit-agents. It costs 36 tokens per session (2,173 once invoked), scanned A, original, MIT.

A planning guide for web APIs, which are agreed ways for programs to request and exchange data. It covers styles such as REST, GraphQL, and tRPC and can produce an OpenAPI description.

In plain words
What is it for?
It helps design endpoints, model resources and their relationships, choose an API style, define request and response schemas, and document authentication, limits, and errors.
Why use it?
It helps settle data formats, routes, access rules, errors, pagination, and versioning before implementation, reducing inconsistent interfaces.

Skill for Claude CodeCodex

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

Good fit It helps design endpoints, model resources and their relationships, choose an API style, define request and response schemas, and document authentication, limits, and errors.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/pixel-process-ug/superkit-agents/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 Pixel-Process-UG/superkit-agents --skill api-design
Clone the repo
git clone --depth 1 https://github.com/Pixel-Process-UG/superkit-agents

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/pixel-process-ug/superkit-agents/api-design/github.svg)](https://agentmods.dev/skills/pixel-process-ug/superkit-agents/api-design)
Your own site
<a href="https://agentmods.dev/skills/pixel-process-ug/superkit-agents/api-design"><img src="https://agentmods.dev/badge/skills/pixel-process-ug/superkit-agents/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/pixel-process-ug/superkit-agents/api-design"><img src="https://agentmods.dev/badge/skills/pixel-process-ug/superkit-agents/api-design.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 36 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,173 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.00036 $0.02173
Opus 5.5 $0.00014 $0.00869
Sonnet 5.5 $0.00007 $0.00435
Haiku 4.5 $0.00004 $0.00217

Measured 1mo ago against content hash 923019aab071, 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/skills/api-design/SKILL.md · 260 lines

How it starts

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

API Design

Overview

Structured API endpoint design through guided discovery. Produces consistent, well-documented API designs with OpenAPI/Swagger specifications. Covers resource modeling, authentication, pagination, error handling, and versioning — ensuring consumer-centric design before any implementation begins.

Announce at start: "I'm using the api-design skill to design the API."

Phase 1: Discovery

Ask these questions ONE AT A TIME:

Resource Questions

# Question What It Determines
1 What entities/resources does this API manage? Resource naming
2 What are the relationships between them? Nested routes, includes
3 What operations are needed for each? (CRUD, search, batch) HTTP methods, endpoints

Consumer Questions

# Question What It Determines
4 Who will consume this API? (frontend, mobile, third-party, internal) Response shape, auth model
5 What authentication/authorization is needed? Security scheme
6 What rate limits or quotas apply? Rate limiting headers

Constraint Questions

# Question What It Determines
7 REST, GraphQL, or tRPC? API paradigm
8 Versioning strategy? (URL path, header, query param) URL structure
9 Pagination approach? (cursor, offset, keyset) List response shape
10 Existing API conventions in the codebase? Consistency constraints

API Paradigm Decision Table

Factor Choose REST Choose GraphQL Choose tRPC
Consumers Multiple, diverse Frontend-heavy, flexible queries TypeScript monorepo
Caching needs Strong (HTTP caching) Moderate (client-side) Low (internal only)
Data shape Predictable, resource-oriented Nested, variable-shape Type-safe RPC
Team familiarity Universal Requires schema knowledge Requires TypeScript
Real-time needs WebSocket addon Subscriptions built-in Subscription support

Read the full file on GitHub · 260 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 · 260 lines · 36 tokens per session scan A 923019aab071

Subscribe to this mod's changes

api-design is a skill published in the GitHub repository Pixel-Process-UG/superkit-agents (3 stars, last pushed 7mo ago), licensed MIT. It adds 36 tokens to every session and 2,173 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

api-and-interface-design

Guides stable API and interface design. Use when designing APIs, module boundaries, or any public interface. Use when creating REST or GraphQL endpoints, defining type contracts between modules, or establishing boundaries between frontend and backend.

addyosmani/agent-skills · 49 tokens

create-slack-app

Use when a developer wants to create, scaffold, or bootstrap a new Slack app or agent from scratch with the Slack CLI. Covers prerequisites, authentication, choosing a workspace to install into, and creating a project from a Bolt (JS or Python) template locally. Trigger on "create a Slack app", "new Bolt app", "start…

slackapi/slack-skills-plugin · 76 tokens

slack-api

Use when a developer asks which Slack Web API method does something, needs a method's OAuth scopes or token type, wants to call or test a family.method endpoint (chat.postMessage, conversations.history, users.info, views.open), is handling cursor pagination (nextcursor) or rate limits (tier/ratelimited/Retry-After)…

slackapi/slack-skills-plugin · 109 tokens

awesome-performance-audit

Read-only performance and reliability audit: event loop, backpressure, memory and CPU, timeouts, retries, queues, Core Web Vitals, bundles, with a verdict. Use when something is slow, memory climbs or latency spikes.

khasky/awesome-agent-skills · 52 tokens

awesome-error-standards

Applies consistent error handling: typed errors, operational vs programmer errors, API error envelopes, HTTP status mapping, user-facing messages. Use when adding or refactoring error handling or designing an error contract.

khasky/awesome-agent-skills · 46 tokens

api-and-interface-design

Guidance for designing stable, clearly documented interfaces between software parts, such as web APIs, GraphQL schemas, modules, and component properties. It covers defining the contract first, limiting accidental dependencies, and planning safe changes.

vinvcn/addyosmani-agent-skills-zh · 51 tokens