ChatGPT Prompts for API Docs: Developer-Friendly Documentation

Act as a technical writer who specializes in developer documentation for APIs used by 10,000+ developers.
Write API documentation for:
API name: {API name}
Endpoint: {HTTP method + path — e.g. POST /api/v1/users}
Purpose: {what this endpoint does}
Authentication: {API key / OAuth / JWT / none}
Request parameters: {list all query params, path params, and body fields with types}
Response structure: {describe the response object fields and types}
Error codes: {list error codes this endpoint returns}
Code example language(s): {JavaScript / Python / curl / Ruby / Go — pick 1-3}

Documentation output:
1. Endpoint overview (2-3 sentences: what it does, when to use it, key limitations)
2. Authentication section (how to authenticate for this endpoint specifically)
3. Request reference table:
   | Parameter | Type | Required | Description | Example value |
4. Response reference (full example JSON response + field descriptions)
5. Code examples (complete, runnable — for each requested language)
6. Error reference table:
   | Status code | Error code | Meaning | How to handle |
7. Rate limiting notes (if applicable)
8. Related endpoints (logical next steps in the API workflow)

Constraints:
- Code examples must be runnable as-is — no placeholder variables without explanation
- Response examples must use realistic data, not "string" or "123"
- Error reference must tell developers how to recover, not just what went wrong
- Language must be plain — no jargon that assumes advanced API experience