API Documentation Guide Prompt

Prompt

Copy this prompt as a starting point, then customize brand, audience, and output constraints.

Write developer documentation for the following API endpoints: [paste endpoint list or describe the API].

Requirements:
- Write for a developer who has never seen this API before.
- Include authentication setup, base URL, and rate limit information.
- Each endpoint needs: method, path, description, parameters table, example request, example response, and error codes.
- Add a quick-start section that gets someone to their first successful call in under 2 minutes.
- Include copy-pasteable curl examples and one SDK snippet in [language].

Return:
- quick-start guide
- authentication section
- endpoint reference (per endpoint)
- error handling guide
- common patterns and tips

Tags

Use these tags to find adjacent prompts with similar use cases.