Task prompt · Coding
Write documentation for my API
by Agent Yard TeamReference docs with examples for every endpoint.
You'll attach
Needs file
Works with
Cursor
Claude Code
Codex
Claude
ChatGPT
GeminiUse cases
- Reference docs with examples for every endpoint.
- When you already have a file and want the AI to work from it instead of starting from scratch.
- With Cursor, Claude Code, Codex and more, the AIs that support what this prompt needs.
Featured in: Best Claude prompts for coding.
How to use it
- Open Cursor or Claude Code in your terminal (or another AI listed here).
- Attach the file (PDF, Word, CSV or Excel), or paste its text into the prompt.
- Copy the prompt, paste it into the chat and send.
Prompt
Write API documentation from the attached code or OpenAPI file. For each endpoint: purpose, method and path, auth, parameters with types, request and response examples, errors. Add a quick-start guide with a curl example. Document only what the code actually does.
One email a week
The Weekly is presented byyour brandSponsored · openThe best new prompts and personas, nothing else.