api-documentation

api-documentation is a skill for Claude Code from sickn33/agentic-awesome-skills. It costs 23 tokens per session (967 once invoked), scanned A, original, MIT.

A workflow for documenting APIs and producing OpenAPI specifications, developer guides, examples, and interactive documentation. OpenAPI is a standard machine-readable description of an API's endpoints and data.

In plain words
What is it for?
Use it to inventory endpoints, describe requests and responses, create an OpenAPI document, and write guides with code examples.
Why use it?
API details are easy to leave incomplete or inconsistent, making an API harder to use and maintain. This workflow organises endpoint discovery, authentication notes, error codes, limits, and usage instructions.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the agentic-awesome-skills plugin — 257 skills shipped together

Good fit Use it to inventory endpoints, describe requests and responses, create an OpenAPI document, and write guides with code examples.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/sickn33/agentic-awesome-skills/api-documentation
About the project

AAS Core is a local control plane for coding agents that lets them search a large catalogue of skills, choose a stack, validate it, and create a reproducible plan. It is used to assemble and review agent workflows through its CLI, local MCP server, catalogue, plugins, and Workbench. The catalogue add-ons provide the skills, plugins, bundles, and workflows that AAS Core helps agents select and validate.

sickn33/agentic-awesome-skills · 48,465 stars · on GitHub · aaskills.tech

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 sickn33/agentic-awesome-skills --skill api-documentation
Clone the repo
git clone --depth 1 https://github.com/sickn33/agentic-awesome-skills

Made for: Claude Code.

Or install agentic-awesome-skills, the plugin that ships this one along with the rest of its 257 skills.

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-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/sickn33/agentic-awesome-skills/api-documentation/github.svg)](https://agentmods.dev/skills/sickn33/agentic-awesome-skills/api-documentation)
Your own site
<a href="https://agentmods.dev/skills/sickn33/agentic-awesome-skills/api-documentation"><img src="https://agentmods.dev/badge/skills/sickn33/agentic-awesome-skills/api-documentation/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-documentation

Your own site · 80×15
<a href="https://agentmods.dev/skills/sickn33/agentic-awesome-skills/api-documentation"><img src="https://agentmods.dev/badge/skills/sickn33/agentic-awesome-skills/api-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 23 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 967 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • Snyk pass 7 Sept 2026
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
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.00023 $0.00967
Opus 5.5 $0.00009 $0.00387
Sonnet 5.5 $0.00005 $0.00193
Haiku 4.5 $0.00002 $0.00097

Measured 10d ago against content hash 6b111ef252cc, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

api-documentation scanned grade A with 1 finding 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 10d 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

3. Add curl examples
Origin

Copies of this mod

8 near-identical copies found in the catalogue:

plugins/agentic-awesome-skills-claude/skills/api-documentation/SKILL.md · 175 lines

How it starts

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

API Documentation Workflow

Overview

Specialized workflow for creating comprehensive API documentation including OpenAPI/Swagger specs, developer guides, code examples, and interactive documentation.

When to Use This Workflow

Use this workflow when:

  • Creating API documentation
  • Generating OpenAPI specs
  • Writing developer guides
  • Adding code examples
  • Setting up API portals

Scope and execution

Choose the phases that match the user’s task; this document is an index, not an instruction to run every listed skill. Read a selected skill before using it. Respect repository and user constraints. Cloud calls, host configuration, publishing, destructive operations and spending require the applicable authorization; a workflow checklist does not grant it.

Base the contract on the actual implementation/specification and keep secrets out of examples. “Try it” can send real requests: use explicit sandbox endpoints and test credentials. Preview documentation locally before publishing; deployment is a separate authorized action.

Workflow Phases

Phase 1: API Discovery

Skills to Invoke
  • api-documenter - API documentation
  • api-design-principles - API design
Actions
  1. Inventory endpoints
  2. Document request/response
  3. Identify authentication
  4. Map error codes
  5. Note rate limits
Copy-Paste Prompts
Use @api-documenter to discover and document API endpoints

Phase 2: OpenAPI Specification

Skills to Invoke
  • openapi-spec-generation - OpenAPI
  • api-documenter - API specs
Actions
  1. Create OpenAPI schema
  2. Define paths
  3. Add schemas
  4. Configure security
  5. Add examples
Copy-Paste Prompts
Use @openapi-spec-generation to create OpenAPI specification

Phase 3: Developer Guide

Skills to Invoke
  • api-documentation-generator - Documentation
  • documentation-templates - Templates
Actions
  1. Create getting started
  2. Write authentication guide
  3. Document common patterns
  4. Add troubleshooting
  5. Create FAQ

Read the full file on GitHub · 175 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. 10d ago Changed · +6 lines 6b111ef252cc
  2. 1mo ago First seen · 169 lines · 23 tokens per session scan A 9b7068b8c2c2

Subscribe to this mod's changes

api-documentation is a skill published in the GitHub repository sickn33/agentic-awesome-skills (48,465 stars, last pushed yesterday), licensed MIT. It adds 23 tokens to every session and 967 once invoked, about $0.0001 per session on Opus 5.5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-05.