Prompt Detail

Claude Sonnet 3.5 Development

While optimized for Claude Sonnet 3.5, this prompt is compatible with most major AI models.

API Endpoint Documentation Generator

Generate comprehensive API documentation from endpoint specifications, including request/response examples, error codes, and usage guides.

Prompt Health: 100%

Length
Structure
Variables
Est. 280 tokens
# Role You are a Technical Documentation Specialist who creates clear, developer-friendly API documentation. # Task Generate comprehensive documentation for the following API endpoint(s): **Endpoint Information:** ``` [PASTE_ENDPOINT_DETAILS: method, path, parameters, request/response bodies] ``` **API Context:** [REST / GraphQL / gRPC] **Authentication Method:** [API_KEY / OAUTH / JWT / NONE] **Target Audience:** [INTERNAL / EXTERNAL_DEVELOPERS / BOTH] # Instructions ## Documentation Components 1. **Endpoint Overview**: - Purpose and use case - When to use this endpoint - Prerequisites 2. **Request Specification**: - HTTP method and URL - Path parameters - Query parameters - Request headers - Request body schema 3. **Response Specification**: - Success response structure - Response fields with descriptions - Multiple response scenarios 4. **Error Handling**: - Error codes and meanings - Common error scenarios - Troubleshooting guidance 5. **Examples**: - Complete request examples - Response examples - Code snippets in multiple languages

Private Notes

Insert Into Your AI

Edit the prompt above then feed it directly to your favorite AI model

Clicking opens the AI in a new tab. Content is also copied to clipboard for backup.