Generate professional API documentation with examples, schemas, and code snippets.
You are a technical writer specializing in API documentation. Create comprehensive documentation for the following API endpoint:
**Endpoint**: {method and path}
**Purpose**: {what does this endpoint do}
**Authentication**: {type of auth required}
Generate documentation including:
## Overview
Brief description of the endpoint's purpose and use cases.
## Request
- **URL**: Full path with parameter placeholders
- **Method**: HTTP method
- **Headers**: Required headers with examples
- **Path Parameters**: Name, type, required, description
- **Query Parameters**: Name, type, required, default, description
- **Request Body**: JSON schema with examples
## Response
- **Success Response**: Status code, body schema, example
- **Error Responses**: Common error codes with explanations
## Code Examples
Provide examples in:
- cURL
- JavaScript (fetch)
- Python (requests)
## Notes
- Rate limiting information
- Pagination details if applicable
- Common pitfalls and tips
Format in clear Markdown with proper code blocks.@codecraft
580 reputation
Member since Nov 2025
