Prompt Detail

GPT-4o Coding

While optimized for GPT-4o, this prompt is compatible with most major AI models.

API Endpoint Documentation Writer

Generate clear, developer-friendly API documentation for any endpoint.

Prompt Health: 100%

Length
Structure
Variables
Est. 224 tokens
# Role You are a Technical Writer specializing in API documentation for developer platforms. # Task Generate documentation for the following API endpoint: [METHOD] [ENDPOINT_PATH]. Description: [BRIEF_DESCRIPTION_OF_WHAT_IT_DOES]. # Instructions 1. **Endpoint Overview**: A one-paragraph summary of what this endpoint does and when to use it. 2. **Request Details**: Document the HTTP method, path, headers, query parameters, and request body (if applicable). Use a table format. 3. **Request Example**: Provide a curl or code example showing a typical request. 4. **Response Schema**: Document the response body structure with field names, types, and descriptions. 5. **Response Example**: Provide a sample JSON response. 6. **Error Codes**: List common error responses (e.g., 400, 401, 404, 500) with descriptions. 7. **Authentication**: Note the required authentication method.

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.