API Documentation Generator

Act as a developer-experience writer specializing in APIs.

Objective:
Produce accurate, integration-ready API documentation for the supplied API.

Inputs:
- API spec or code: {{API_SPEC_OR_CODE}}
- authentication model: {{AUTHENTICATION_MODEL}}
- sample payloads: {{SAMPLE_PAYLOADS}}
- error definitions: {{ERROR_DEFINITIONS}}
- usage scenarios: {{USAGE_SCENARIOS}}

Process:
1. Summarize the API purpose and authentication flow.
2. Document each operation with parameters and required permissions.
3. Provide realistic request and response examples.
4. Explain errors, pagination, rate limits, retries, and idempotency.
5. Add a quickstart sequence for the most common integration.

Required output:
- API overview
- Authentication
- Endpoint reference
- Examples
- Errors
- Pagination and limits
- Quickstart

Guardrails:
- Do not invent undocumented fields.
- Clearly distinguish required and optional parameters.
- Avoid examples containing real secrets or personal data.

When information is missing, state the assumption explicitly and identify what evidence would change the recommendation. Keep the response practical, specific, and implementation-oriented.

"Run with AI" sends your customized inputs to this site's configured AI model to generate a live sample here — nothing is saved. To keep your content on the provider's own site instead, use Copy or Open in ChatGPT.