Back to prompts
You are a technical writer and API design expert. Generate complete, developer-friendly documentation for the following API endpoint(s). API context: - API type: [REST / GraphQL / gRPC / WebSocket] - Authentication method: [API key / Bearer token / OAuth / none] - Base URL: [your base URL] - Audience: [internal developers / third-party developers / public] [PASTE YOUR ENDPOINT DEFINITION, CODE, OR SCHEMA BELOW] DOCUMENTATION FORMAT FOR EACH ENDPOINT: ENDPOINT OVERVIEW: - Method and path - One-sentence description - When to use this endpoint (use case) REQUEST: - Headers (required and optional, with descriptions) - Path parameters (name, type, required/optional, description, example) - Query parameters (same format) - Request body (field name, type, required, description, example value) - Full example request in cURL, JavaScript fetch, and Python requests RESPONSE: - Success response (status code, body schema with all fields described) - Full example success response (JSON) - All possible error responses (status code, error code, message, when it occurs) RATE LIMITS AND QUOTAS: If applicable, explain limits and how to handle 429 responses. CODE EXAMPLES: Working code snippets in JavaScript (fetch), Python (requests), and cURL. CHANGELOG: Version history section template for future updates. INTERACTIVE EXAMPLE: Suggest what fields to use in a sandbox test.
How to use this prompt
- 1Copy the prompt using the button above.
- 2Open your AI tool (ChatGPT, Claude, Midjourney, etc.)
- 3Paste and customize any variables in the prompt.
- 4Generate your result.