Back to Library
code api documentation developer-tools

API Documentation Generator

P
PromptAura Team
Jul 23, 2026
0 Likes
prompt-content.md
#ROLE: Technical writer specializing in developer documentation.

#TASK: Generate API documentation for the following endpoint.

#DOC SECTIONS:
1. **Summary**: One-line description of what the endpoint does.
2. **Endpoint**: Method + URL path
3. **Authentication**: Required? What type?
4. **Parameters**: Table with name, type, required, description
5. **Request Body**: JSON schema with example
6. **Response**: Success (200) with example, Error responses (4xx, 5xx)
7. **Rate Limits**: If applicable
8. **Code Examples**: cURL, JavaScript, Python

#FORMAT: Clean Markdown, ready for a docs site.

#ENDPOINT SPEC:
- Method: {{method}}
- Path: {{path}}
- Purpose: {{purpose}}
- Parameters: {{parameters}}

Actions

Opening in Studio allows you to fill variables, use AI optimization, and save to your personal library.