Creates comprehensive API documentation including examples, error handling, and use cases from endpoint specifications.
You are an expert technical writer specializing in API documentation. I need you to create comprehensive documentation for an API endpoint. [PASTE API SPECIFICATION OR ENDPOINT DETAILS] Please create documentation that includes: 1. **Overview**: A clear, concise description of what this endpoint does and when to use it 2. **Authentication**: What authentication is required (if any) 3. **Request Format**: - HTTP method and URL pattern - Required and optional parameters (path, query, body) - Request headers - Example request with curl and in at least one programming language 4. **Response Format**: - Success response structure with field descriptions - Example success response - Error responses with status codes and meanings 5. **Rate Limiting**: Any rate limit considerations 6. **Common Use Cases**: 2-3 practical examples of when/how to use this endpoint 7. **Related Endpoints**: Suggest related endpoints if applicable Use clear, scannable formatting with code blocks, tables where appropriate, and consistent terminology throughout.
You are an expert technical writer specializing in API documentation. I need you to create comprehensive documentation for an API endpoint. [PASTE API SPECIFICATION OR ENDPOINT DETAILS] Please create documentation that includes: 1. **Overview**: A clear, concise description of what this endpoint does and when to use it 2. **Authentication**: What authentication is required (if any) 3. **Request Format**: - HTTP method and URL pattern - Required and optional parameters (path, query, body) - Request headers - Example request with curl and in at least one programming language 4. **Response Format**: - Success response structure with field descriptions - Example success response - Error responses with status codes and meanings 5. **Rate Limiting**: Any rate limit considerations 6. **Common Use Cases**: 2-3 practical examples of when/how to use this endpoint 7. **Related Endpoints**: Suggest related endpoints if applicable Use clear, scannable formatting with code blocks, tables where appropriate, and consistent terminology throughout.
This prompt is released under CC0 (Public Domain). You are free to use it for any purpose without attribution.
Explore similar prompts based on category and tags
Creates comprehensive SOPs with clear procedures, troubleshooting guides, and proper documentation structure.
Creates comprehensive release notes with user-friendly announcements, technical changelogs, and social media posts.
Transform messy notes into clear professional meeting minutes
Drafts crisis communication statements, Q&As, and internal messaging with appropriate tone and structure.
Writes balanced comparison articles with verdict tables, detailed category breakdowns, and clear recommendations.