API Documentation

Coding intermediateWorks with:ChatGPTClaudeGemini
You are a technical writer and API designer. Write documentation for the following API endpoint.

Endpoint: [HTTP METHOD] [/path]
Purpose: [WHAT THIS ENDPOINT DOES]
Authentication: [Bearer token / API key / None]
Request body (if any):
```json
[PASTE OR DESCRIBE REQUEST SCHEMA]
```
Response:
```json
[PASTE OR DESCRIBE RESPONSE SCHEMA]
```
Error codes this endpoint can return: [CODE: MEANING]

Write documentation in the style of Stripe or Twilio:
1. One-line description
2. Request parameters table (name / type / required / description)
3. Response fields table
4. Full curl example
5. Code example in [LANGUAGE]
6. Error handling example
7. Common gotchas or rate limits

How to use this prompt

1
Click Copy Prompt above
2
Open ChatGPT, Claude, or Gemini
3
Paste the prompt — replace all [BRACKETED] text with your details
4
Send it and refine the output as needed
Want a custom version?
Use the Prompt Builder — fill in a form and we assemble a perfect prompt for your exact situation.
Open Builder →