writingintermediate
API Documentation Writer
Creates clear, complete API documentation with examples for every endpoint.
Prompt
Write developer-facing API documentation for the following endpoint(s):
**Base URL**: {{baseUrl}}
**Authentication**: {{authMethod}}
**Endpoints**:
{{endpoints}}
For each endpoint include:
- **Title and description**: what it does in one sentence
- **HTTP method and path**
- **Authentication**: required scopes/permissions
- **Request**: headers, path parameters, query parameters, request body (with JSON schema, required/optional, types, constraints, defaults)
- **Response**: success response (with full JSON example), error responses (400, 401, 403, 404, 422, 429, 500)
- **Code examples**: cURL, Python (requests), JavaScript (fetch), and Go
- **Rate limits**: if applicable
- **Changelog**: version when introduced, breaking changes
Use clear, imperative language. Every field must have a type and description.Variables
{{baseUrl}}{{authMethod}}{{endpoints}}
Use Cases
- API reference documentation
- Developer portal content
- SDK documentation
Compatible Models
claude-sonnet-4-20250514gpt-4o
Tags
api-docsdocumentationdeveloper-experience
Details
- Author
- PromptIndex
- Updated
- 2026-04-01
- Difficulty
- intermediate
Related Prompts
- Technical Blog Post Writer
Generates a well-structured technical blog post with code examples and diagrams.
- Changelog Generator
Generates a structured changelog from git commit history or diff.
- Release Notes Writer
Creates polished release notes suitable for GitHub releases or email announcements.