api-doc-writing

api-doc-writing is a skill for Codex from jeremylongworth-source/AgentSkills. It costs 52 tokens per session (316 once invoked), scanned A, original, MIT.

A guide for writing or improving documentation for web APIs, which are interfaces that let software exchange requests and responses. It covers endpoints, SDK methods, schemas, authentication, errors, limits, and examples.

In plain words
What is it for?
Use it to document API contracts, request and response formats, permissions, errors, rate limits, examples, and review gaps.
Why use it?
It helps produce documentation from real code or specifications without inventing how the API behaves.

Skill for Codex

Written for Codex: agents/openai.yaml present. Also seen: mentions Codex.

Good fit Use it to document API contracts, request and response formats, permissions, errors, rate limits, examples, and review gaps.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/jeremylongworth-source/agentskills/api-doc-writing
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 jeremylongworth-source/AgentSkills --skill api-doc-writing
Clone the repo
git clone --depth 1 https://github.com/jeremylongworth-source/AgentSkills

Made for: 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-doc-writing

README.md
[![agentmods](https://agentmods.dev/badge/skills/jeremylongworth-source/agentskills/api-doc-writing.svg)](https://agentmods.dev/skills/jeremylongworth-source/agentskills/api-doc-writing)
Your own site
<a href="https://agentmods.dev/skills/jeremylongworth-source/agentskills/api-doc-writing"><img src="https://agentmods.dev/badge/skills/jeremylongworth-source/agentskills/api-doc-writing.svg" alt="Measured on agentmods" height="20"></a>
Per session 52 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 316 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.00052 $0.00316
Opus 5 $0.00026 $0.00158
Sonnet 5 $0.00010 $0.00063
Haiku 4.5 $0.00005 $0.00032

Measured 8d ago against content hash 948563e1b22d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-08, from the pricing page.

Security

Grade A, and why

api-doc-writing 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 8d 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-doc-writing/SKILL.md · 46 lines

What it actually says

API Doc Writing

Core Workflow

  1. Identify the API audience, surface area, source of truth, auth model, and version.
  2. Read code, specs, tests, schemas, or examples before documenting behavior.
  3. Document each operation with purpose, inputs, outputs, auth, errors, limits, side effects, and examples.
  4. Separate stable contract from implementation detail.
  5. Flag unknown behavior, undocumented errors, missing examples, and version mismatches.
  6. Include validation or review steps for generated docs.

Safety Rules

  • Do not invent endpoint behavior, parameters, status codes, auth scopes, rate limits, or guarantees.
  • Do not expose secrets, internal hosts, private tokens, or customer data in examples.
  • Verify platform or third-party API facts from current official docs when the facts may have changed.

Deliverable Shape

For API docs, provide:

  • API overview and version
  • Auth and permission notes
  • Operation reference
  • Request and response examples
  • Error behavior
  • Side effects and idempotency
  • Validation or review notes

References

  • Read references/api-doc-writing-checklist.md when writing or reviewing API documentation.
Files

What ships with it

2 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. 8d ago First seen · 46 lines · 52 tokens per session scan A 948563e1b22d

Subscribe to this mod's changes

api-doc-writing is a skill published in the GitHub repository jeremylongworth-source/AgentSkills (1 stars, last pushed 5d ago), licensed MIT. It adds 52 tokens to every session and 316 once invoked, about $0.0003 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.

Related

Other skills, from other repositories

authos-backend-integration

Secure backend APIs with AuthOS-issued JWTs and the AuthOS Node server adapter. Use when building an API that must verify AuthOS bearer tokens, enforce JWT claims, add Express middleware, validate JWKS keys, or create a backend-owned session after a browser OAuth callback.

drmhse/authos_skill · 62 tokens

authos-webhook-integration

Build AuthOS webhook receivers and manage tenant webhook subscriptions. Use when configuring organization webhooks, subscribing to event types, verifying live delivery signatures, testing delivery history, or using @drmhse/authos-node webhook helpers.

drmhse/authos_skill · 51 tokens

authos-device-flow

Implement AuthOS device authorization for CLIs, TVs, and headless apps. Use when requesting device codes, building activation pages, polling /auth/token, handling MFA during device auth, or adding platform admin CLI login through AuthOS.

drmhse/authos_skill · 52 tokens

authos-rbac-control

Manage AuthOS organization members, roles, invitations, SCIM tokens, and capability-based permissions. Use when implementing team administration, custom roles, service access grants, invitation flows, SCIM provisioning, or authorization checks inside an AuthOS tenant.

drmhse/authos_skill · 54 tokens

authos-service-api-integration

Integrate trusted backend services with AuthOS service API routes using X-Api-Key. Use when listing or managing service users, subscriptions, service metadata, service analytics, or provider-token requests from a server-side application.

drmhse/authos_skill · 50 tokens

authos-platform-deployment

Deploy and configure an AuthOS API instance from source or Docker. Use when setting database backend, JWT signing keys, environment variables, billing provider, SMTP, GeoIP, Docker images, health checks, or production reverse proxy settings.

drmhse/authos_skill · 52 tokens