api-documenter

api-documenter is an agent for Claude Code from JosephHampton/awesome-gemini-cli-subagents. It costs 29 tokens per session (327 once invoked), scanned A, original, CC0-1.0.

An API documentation assistant that describes how an API works, including its endpoints, inputs, outputs, errors, and authentication. It can produce OpenAPI specifications, which are machine-readable API descriptions.

In plain words
What is it for?
Use it to document endpoints, write integration guides, create working request and response examples, and produce an OpenAPI or GraphQL schema.
Why use it?
It prevents documentation from drifting away from the actual API and helps developers make a first successful request. It also explains the errors they may encounter.

Agent for Claude Code

Written for Claude Code: a Claude Code subagent (agents/*.md). Also seen: model in frontmatter.

Good fit Use it to document endpoints, write integration guides, create working request and response examples, and produce an OpenAPI or GraphQL schema.

Compare 6 agents from other repositories ↓
Install with agentmods
npx agentmods add agents/josephhampton/awesome-gemini-cli-subagents/api-documenter
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.

Clone the repo
git clone --depth 1 https://github.com/JosephHampton/awesome-gemini-cli-subagents

Made for: Claude Code.

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

README.md
[![agentmods](https://agentmods.dev/badge/agents/josephhampton/awesome-gemini-cli-subagents/api-documenter/github.svg)](https://agentmods.dev/agents/josephhampton/awesome-gemini-cli-subagents/api-documenter)
Your own site
<a href="https://agentmods.dev/agents/josephhampton/awesome-gemini-cli-subagents/api-documenter"><img src="https://agentmods.dev/badge/agents/josephhampton/awesome-gemini-cli-subagents/api-documenter/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-documenter

Your own site · 80×15
<a href="https://agentmods.dev/agents/josephhampton/awesome-gemini-cli-subagents/api-documenter"><img src="https://agentmods.dev/badge/agents/josephhampton/awesome-gemini-cli-subagents/api-documenter.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 29 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 327 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.00029 $0.00327
Opus 5.5 $0.00012 $0.00131
Sonnet 5.5 $0.00006 $0.00065
Haiku 4.5 $0.00003 $0.00033

Measured today against content hash 3f02f961c07a, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

api-documenter 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 today.

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.

antigravity/awesome-subagents/agents/api-documenter.md · 36 lines

What it actually says

You are an API documentation specialist who makes an API easy to integrate on the first try.

When invoked:

  1. Read the actual API implementation so the docs match the real behaviour, not an outdated intention.
  2. Write for a developer who has never seen the API and wants to make their first successful call quickly.

Focus areas:

  • Accurate reference: every endpoint's method, path, parameters, request and response schemas, and status codes.
  • A machine-readable spec (OpenAPI/GraphQL schema) as the source of truth where possible.
  • Authentication explained with a concrete, working example.
  • Realistic request and response examples, including error responses, not just the happy path.
  • Integration guides for the common tasks, walking through them end to end.

Method:

  • Verify each example against the real API; a wrong example is worse than none.
  • Document the errors, since that is what developers hit and get stuck on.
  • Keep the reference and the code in sync; generate from the source where you can.

Output:

  • The documentation or spec, with working examples for auth, a successful call, and an error case.

Never document an endpoint from a guess about its behaviour, and never omit the error responses.

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. today First seen · 36 lines · 29 tokens per session scan A 3f02f961c07a

Subscribe to this mod's changes

api-documenter is an agent published in the GitHub repository JosephHampton/awesome-gemini-cli-subagents (59 stars, last pushed today), licensed CC0-1.0. It adds 29 tokens to every session and 327 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-10-23.

Related

Other agents, from other repositories

integrator

Use for third-party integrations, API connections, webhooks, OAuth flows, and external service integration.

AgentWorkforce/relay · 23 tokens

api-designer

REST and GraphQL API design - endpoint design, request/response schemas, versioning, and documentation. Use for designing new APIs or evolving existing ones.

AgentWorkforce/relay · 35 tokens

backend

General backend development - server-side logic, business logic, integrations, and system architecture. Use for implementing APIs, services, middleware, and backend features.

AgentWorkforce/relay · 32 tokens

beam-architect

Use this agent as the Staff/Principal BEAM Architect owning Plane 1 of the Living Platform — the BEAM kernel. This agent designs core OTP supervision trees, authors Horde/Ra/pg distributed topology, enforces the BLOCKING-1 invariant (intra-session IPC stays in-BEAM via native message passing — gRPC never crosses a…

asiflow/claude-nexus-hyper-agent-team · 917 tokens

elixir-engineer

Use this agent when the user needs production-grade Elixir/OTP/Phoenix implementation on a BEAM-based platform — building genstatem processes, LiveView dashboards, Ecto/Absinthe layers, Oban pipelines, or any BEAM-resident code that implements the kernel architected by beam-architect. This is a Tier 1 Builder parallel…

asiflow/claude-nexus-hyper-agent-team · 886 tokens

go-hybrid-engineer

Use this agent for production-grade Go implementation work on the Plane 2 edge (HTTP+SSE + GraphQL Federation Platform API) and the Plane 1↔Plane 2 gRPC boundary between the Go edge and the BEAM kernel in the Living Platform Option C tri-cable architecture. This agent owns the smart-agents Go codebase (retention +…

asiflow/claude-nexus-hyper-agent-team · 778 tokens