API Documentation Generator

Prompt

Generate comprehensive API documentation for [API NAME] at [COMPANY NAME].

API details:
- API type: [REST / GraphQL / gRPC / SOAP]
- Base URL: [URL]
- Authentication method: [API KEY / OAuth / JWT / BASIC]
- Primary use cases: [WHAT DEVELOPERS DO WITH THIS API]
- Target developer audience: [INTERNAL / EXTERNAL / PARTNER]
- Existing endpoints to document: [LIST ENDPOINTS OR PASTE SPEC]

Create complete API documentation:

1. **Introduction** — What this API does, who it's for, and what they can build.

2. **Authentication** — Step-by-step guide to getting and using credentials. Include code examples.

3. **Quick Start** — Working example from zero to first successful API call in under 10 minutes.

4. **Endpoint Reference** — For each endpoint:
   - Method and path
   - Description
   - Request parameters (path, query, body) with types, required/optional, descriptions
   - Request example (curl and at least one SDK)
   - Response schema with types
   - Response example (success and common errors)
   - Rate limits and pagination if applicable

5. **Error Reference** — All error codes with descriptions and resolution steps.

6. **Code Examples** — Working samples in [LANGUAGES: PYTHON / JS / JAVA / GO].

7. **Changelog** — Format for documenting API changes.

8. **Support and Feedback** — How to get help and report issues.