API Documentation Generator
Prompt
Generate API documentation for the following endpoint. Method: {method}. Path: {path}. Description: {description}. Parameters: {parameters}. Auth: {auth_type}. Response format: {response_format}. Include: endpoint overview, authentication, request parameters (table), example request (cURL + Python), example response, error codes, and rate limits.Variables
method
path
description
parameters
auth_type
response_format
About This Prompt
Generate clear API documentation from endpoint specifications with examples.
Example Output
## GET /api/v1/agents
Retrieve a list of AI agents with optional filtering and pagination.
### Authentication
Requires Bearer token in the Authorization header.
### Parameters
Parameter
Type
Required
Description
-----------
------
----------
-------------
category
string
No
Filter by agent category
limit
integer
No
Results per page (default: 20, max: 100)
offset
integer
No
Pagination offset
### Example Request
```bash
curl -X GET 'https://api.example.com/api/v1/agents?category=chatbots&limit=10'
-H 'Authorization: Bearer YOUR_API_KEY'
```
Usage Tips
- Include working code examples
- Document all error codes
- Show both success and error responses
- Keep descriptions concise