Write an API reference people can use right away

Prompt that turns code and examples into a per-endpoint reference with error codes and working calls. Paste it into an AI tool of your choice, which then writes the API reference.

Topic: Apps & prototypes
Type: Prompt
Level: Intermediate
Time: about 10 min

Results depend on the tool, the model and what you enter.

Result preview

Example: written by our editors, not real AI output.

Fill in

What you type stays in this browser window. We store and send nothing.

APIWhich API is it?

MaterialWhat do you have?

ReadersWho reads the reference?

Your prompt

Write a reference for the following API.
API: [API]
Material: [Material]
Readers: [Readers]
Approach: 1. List every endpoint with method, path and one sentence on its purpose. 2. For each endpoint, describe path, query and body parameters with type, required or not, default and allowed values. 3. Show a complete example call and example response per endpoint, with placeholders instead of real data. 4. List every error code with its cause and what callers should do. 5. Explain authentication, rate limits, pagination and versioning in one place. 6. Mark anything you cannot derive reliably from the material as an open question.
Output: reference in Markdown, one section per endpoint, with the list of open questions at the end.

Take particular care to document only what the material supports and mark anything unclear as an open question.

Before you answer, check: Are all instructions met? If key information is missing or a placeholder in square brackets is still in the text, ask instead of guessing. Mark assumptions as assumptions.

Write a reference for the following API.
API: [API]
Material: [Material]
Readers: [Readers]
Approach: 1. List every endpoint with method, path and one sentence on its purpose. 2. For each endpoint, describe path, query and body parameters with type, required or not, default and allowed values. 3. Show a complete example call and example response per endpoint, with placeholders instead of real data. 4. List every error code with its cause and what callers should do. 5. Explain authentication, rate limits, pagination and versioning in one place. 6. Mark anything you cannot derive reliably from the material as an open question.
Output: reference in Markdown, one section per endpoint, with the list of open questions at the end.

Take particular care to document only what the material supports and mark anything unclear as an open question.

Before you answer, check: Are all instructions met? If key information is missing or a placeholder in square brackets is still in the text, ask instead of guessing. Mark assumptions as assumptions.

This is an instruction for an AI, not the result itself.

Where this prompt works

These AI tools are a good fit for this prompt:

How to use it

Fill in the fields or tap a suggestion. Leave out names, addresses and other personal data.
Copy the finished prompt into an AI tool of your choice.
Give only the reference to someone who does not know the API. If they make a first successful call without asking, the reference is good.

Why does this work?

References rarely fail because endpoints are missing. They fail on missing error codes, unclear required fields and examples that do not run. A fixed structure per endpoint, plus open questions instead of guessed answers, makes them reliable.

Tips

Replace keys, tokens and customer data in examples with placeholders before you put material into the AI tool.

You may use our prompts freely, including at work. Please do not republish them as your own collection. We give no warranty for AI results; check them yourself. Terms of use

Write an API reference people can use right away

Result preview

Fill in

Your prompt

Where this prompt works

How to use it

Why does this work?

Tips

Also a good fit

Choose pagination for an API list New

Plan a throttled data backfill New

Plan caching for a slow endpoint New