api-and-interface-design

api-and-interface-design is a skill for Claude Code, Codex from vignesh2027/AI-AGENT-SKILLS. It costs 17 tokens per session (560 once invoked), scanned A, original, MIT.

A guide for designing APIs, the interfaces that software uses to communicate, so they stay consistent and can change without breaking callers.

In plain words
What is it for?
Use it when designing an API endpoint, software development kit, or library interface, or when reviewing an API used by outside developers.
Why use it?
It helps prevent confusing names, inconsistent inputs and outputs, and unhelpful errors before an API is published or while an existing one causes problems.

Skill for Claude CodeCodex

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

Good fit Use it when designing an API endpoint, software development kit, or library interface, or when reviewing an API used by outside developers.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/vignesh2027/ai-agent-skills/api-and-interface-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 vignesh2027/AI-AGENT-SKILLS --skill api-and-interface-design
Clone the repo
git clone --depth 1 https://github.com/vignesh2027/AI-AGENT-SKILLS

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-and-interface-design

README.md
[![agentmods](https://agentmods.dev/badge/skills/vignesh2027/ai-agent-skills/api-and-interface-design/github.svg)](https://agentmods.dev/skills/vignesh2027/ai-agent-skills/api-and-interface-design)
Your own site
<a href="https://agentmods.dev/skills/vignesh2027/ai-agent-skills/api-and-interface-design"><img src="https://agentmods.dev/badge/skills/vignesh2027/ai-agent-skills/api-and-interface-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-and-interface-design

Your own site · 80×15
<a href="https://agentmods.dev/skills/vignesh2027/ai-agent-skills/api-and-interface-design"><img src="https://agentmods.dev/badge/skills/vignesh2027/ai-agent-skills/api-and-interface-design.svg" alt="Reviewed on agentmods" width="80" 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 560 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.00017 $0.00560
Opus 5 $0.00009 $0.00280
Sonnet 5 $0.00003 $0.00112
Haiku 4.5 $0.00002 $0.00056

Measured 9d ago against content hash 79b93d3ddb98, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

api-and-interface-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 9d 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.

skills/api-and-interface-design/SKILL.md · 55 lines

How it starts

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

Overview

APIs are promises. Once published, they are hard to break without breaking callers. This skill designs APIs that are easy to use correctly, hard to use incorrectly, and evolvable without breaking changes.

When to Use

  • Before designing a new API endpoint, SDK, or library interface
  • Before publishing an API to external consumers
  • When an existing API is causing confusion or misuse

Process

Step 1: Design the API for the caller, not the implementation

Your internal data model should not dictate your API shape. Design for the use case: what does the caller need to do? What information do they have? What do they want back?

Step 2: Consistency over cleverness

Naming, parameter order, error formats, and response shapes should be consistent across the entire API. Consistency is worth more than local elegance.

Step 3: Make the happy path obvious

A caller should be able to guess how to use the API without reading the documentation for the common cases. Reserve documentation for edge cases.

Step 4: Make errors informative

Every error must tell the caller: what went wrong, which field caused it (for validation errors), what they can do to fix it. "Bad request" is not an error message.

Step 5: Version from day one

Build versioning into the API from the first version: /v1/users, not /users. Retrofitting versioning is painful.

Step 6: Design for evolution

  • Additive changes are backward compatible (add fields, add endpoints)
  • Destructive changes break callers (remove fields, rename fields, change types)
  • Use deprecation periods before removing anything
  • Make optional fields optional, not required

Step 7: Define the contract

Document: authentication method, rate limits, request/response schema, error codes, pagination pattern, time formats, ID formats.

Step 8: Respect Hyrum's Law

"With a sufficient number of users of an API, it does not matter what you promise in the contract: all observable behaviors of your system will be depended on by somebody." Design carefully; change carefully.

Read the full file on GitHub · 55 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. 9d ago First seen · 55 lines · 17 tokens per session scan A 79b93d3ddb98

Subscribe to this mod's changes

api-and-interface-design is a skill published in the GitHub repository vignesh2027/AI-AGENT-SKILLS (2 stars, last pushed 11d ago), licensed MIT. It adds 17 tokens to every session and 560 once invoked, about $0.0001 per session on Opus 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.