[agents](https://carteblanche.com/index.md?kind=agent) / [code](https://carteblanche.com/index.md?category=code)

# api-documenter

what it does

Use this agent when creating or improving API documentation, writing OpenAPI specifications, building interactive documentation portals, or generating code examples for APIs.

tools it asks for

Reads files · Edits files · Uses the web

by VoltAgent · version 1 · license MIT

We imported this agent from its author’s repository. Is this yours? [Claim this listing](https://carteblanche.com/claim/api-documenter)

Verified · Before and after: 2 models · 1 try per case · [View source](https://github.com/VoltAgent/awesome-claude-code-subagents/blob/ed74d115b7fb7026a22a4f816a8e3250f425e3b4/categories/07-specialized-domains/api-documenter.md) · [Install from your agent](https://carteblanche.com/connect.md) · [Download .zip](https://carteblanche.com/skills/api-documenter/download)

## Compare the answers

Answers from Claude Sonnet 5.5 and GPT-6.1 Sol · try 1 of 1

Same request, same model, once with the agent’s instructions as its system prompt and once without. Neither could use a tool. Read both and judge for yourself.

[Compare the answers](https://carteblanche.com/skills/api-documenter/compare)

## The models

2 models

Claude Sonnet 5.5

made by Anthropic

claude-sonnet-5-5 · revision not reported by the provider

1 try per case · tested 7 Nov 2026

GPT-6.1 Sol

made by OpenAI

gpt-6.1-sol · revision not reported by the provider

1 try per case · tested 7 Nov 2026

## The tasks

written by Carte Blanche

**example-1**

“I need an OpenAPI 3.0 spec for a small bookstore API. Endpoints: GET /books (query params: author, genre, page, limit), GET /books/{id}, POST /books (body: title, author, isbn, price), and DELETE /books/{id}. Auth is a Bearer JWT. Please include schemas, 404 and 401 error responses, and an example for each response in YAML.”

**example-2**

“Here's our current docs for POST /v1/invoices: 'Creates an invoice. Send customer and items. Returns the invoice.' That's all we have. The body takes customer\_id (string), currency (ISO 4217), due\_date (YYYY-MM-DD), and items\[\] with description, quantity, unit\_price\_cents. It returns 201 with the invoice object, or 422 on validation errors. Can you rewrite this into proper reference docs and add curl, Python requests, and Node fetch examples?”

## Install

Download the .zip and unzip it. Put `api-documenter.md` here:

Claude Code · `~/.claude/agents/` · Every project. For one project only, use .claude/agents/ inside it. It gives the agent the tools it asks for, and no others.

Cursor · `~/.cursor/agents/` · Cursor also reads the Claude Code folder above. It has no tools field, so it gives every agent every tool, whatever this one asks for.

Codex · Codex’s custom agents are TOML files, not Markdown, so this agent doesn’t install there.

Keep its license file beside it, as `api-documenter.LICENSE`: a name that doesn’t end in .md, since every .md file there is read as an agent.

Then start a new session and ask for it by name. Folders checked 6 November 2026.

Or [install from your agent](https://carteblanche.com/connect.md): ask it to install `api-documenter` from Carte Blanche.

## Badge for your README

Carte Blanche: Verified

Paste this into the agent’s README. It links to this page, and shows how the listing stands whenever it’s loaded.

```
[![Carte Blanche](https://carteblanche.com/badge/api-documenter.svg)](https://carteblanche.com/skills/api-documenter)
```

## About this test

- **tested**: 7 Nov 2026
- **version tested**: v1
- **cases**: 2
- **tries per case**: 1 try per case
- **run without the agent**: yes
- **cases written by**: Carte Blanche
- **size**: 6038 characters

What this shows, and what it doesn’t

How 2 models answered these 2 requests, with and without the agent. It says nothing about other models, and it doesn’t limit what your own agent can do.

The answers were written without tools: the agent’s instructions were the system prompt, and it read no file and ran nothing.

[How we test](https://carteblanche.com/how-it-works.md)
