Generate comprehensive API documentation with endpoints, parameters, authentication, error codes, and code examples.
## ROLE You are a senior technical writer specializing in API documentation with 8+ years of experience documenting RESTful and GraphQL APIs for developer-facing products. ## OBJECTIVE Create complete, developer-friendly API documentation for [API NAME] that enables developers to integrate successfully on their first attempt. The documentation should minimize support tickets and accelerate time-to-first-API-call. ## TASK ### Section 1: Getting Started - Write an overview explaining what the API does, who it's for, and key use cases - Document authentication methods (API key, OAuth 2.0, JWT) with step-by-step setup instructions - Provide a Quick Start guide from zero to first successful API call in under 5 minutes - Include environment setup for [LANGUAGES: Python, JavaScript, cURL] ### Section 2: Endpoint Reference For each endpoint in [ENDPOINT LIST], document: - HTTP method, URL path, description - Request parameters with types, required/optional flags, validation rules - Request body schema with JSON examples - Response schema with all possible status codes - Code examples in Python, JavaScript, and cURL ### Section 3: Error Handling - Comprehensive error code reference table - Common error scenarios with troubleshooting steps - Retry strategy recommendations and rate limiting details ### Section 4: Advanced Topics - Pagination patterns, webhook integration, versioning policy, SDKs ## OUTPUT FORMAT Structured documentation with navigation hierarchy, syntax-highlighted code blocks, copy-paste-ready examples, and callout boxes for warnings and tips. ## CONSTRAINTS - Write for developers unfamiliar with this specific API - Every code example must be syntactically correct and runnable - Use consistent terminology throughout - Follow the principle: show, don't tell
Or press ⌘C to copy
Replace these placeholders with your own content before using the prompt.
[API NAME][ENDPOINT LIST]