AI Prompts for API Documentation

Write complete reference documentation for this API endpoint: [DESCRIBE ENDPOINT, METHOD, PATH]. Include: description of what it does, all request parameters (with types, required/optional status, and description), request body schema if applicable, response schema for all status codes (200, 400, 401, 404, 500), and a complete request/response example. Follow OpenAPI conventions.

Write the authentication section of API documentation for [API NAME]. Authentication method: [DESCRIBE, e.g. API key, OAuth 2.0, JWT]. Include: how to obtain credentials, where to include them in requests (header, query parameter, body), code examples in [LANGUAGES], common authentication errors and how to resolve them, and security best practices.

Write the error reference section for [API NAME]. The API returns these error codes and conditions: [LIST ERRORS]. For each error, document: the HTTP status code, the error code in the response body, a description of when it occurs, the response body format, and how a developer should handle it.

Document this data model for an API: [PASTE SCHEMA OR DESCRIBE MODEL]. For each field, include: name, type, whether it is required or optional, any constraints (min/max length, allowed values, format), and a clear description. Add a complete JSON example showing all fields.

Generate an OpenAPI 3.0 specification for this API endpoint: [DESCRIBE ENDPOINT]. Include the complete YAML with: path, operation, parameters, request body, responses with schemas, and basic security scheme. The spec should be valid and usable to generate documentation or client SDKs.

Write a quick start guide for [API NAME] that gets a developer to their first successful API call in under 10 minutes. Include: prerequisites, how to get credentials, installation of any SDKs or tools, a minimal working example (copy-paste ready), and what the expected output is. Assume the developer knows [LANGUAGE] but has never used this API.

Write a step-by-step tutorial for installing and configuring the [LANGUAGE] SDK for [API NAME]. Include: installation command, initialization code, how to configure authentication, a first working example, and how to run it. Each step should be a single clear action with the exact command or code to execute.

Write a developer walkthrough for [SPECIFIC USE CASE, e.g. sending a notification, processing a payment, uploading a file] using [API NAME]. Walk through the full flow step by step: what API calls to make, in what order, with what parameters. Include complete code examples and explain why each step is needed.

Write a migration guide for developers upgrading from [OLD API VERSION] to [NEW VERSION]. Include: all breaking changes with before/after code examples, deprecated features and their replacements, changes that are backwards compatible, a migration checklist, and a timeline for when the old version will stop being supported.

Write a changelog entry for [API NAME] version [VERSION]. Changes in this release: [LIST CHANGES]. For each change, write: a one-line summary, whether it is a new feature, improvement, bug fix, or breaking change, and where relevant a brief code example showing the new behavior. Keep the tone technical but accessible.

Write a complete, runnable code example in [LANGUAGE] that demonstrates [SPECIFIC API FUNCTIONALITY]. The example should: import/require only what is needed, use realistic variable names and data, handle errors correctly, include inline comments explaining non-obvious parts, and produce output that makes success obvious when run.

Write code examples for [API CALL/FEATURE] in these languages: [LIST LANGUAGES]. Each example should: be idiomatic for the language, use the official SDK if available, handle authentication the correct way for that environment, and include error handling. Keep each example self-contained and copy-paste ready.

Write an API recipe for [COMMON PATTERN, e.g. pagination, bulk operations, webhooks, rate limit handling] using [API NAME]. Include: the complete working code, an explanation of the pattern and why it is necessary, common mistakes developers make with this pattern, and how to test that the implementation is correct.

Write curl command examples and a Postman collection description for these [API NAME] endpoints: [LIST ENDPOINTS]. For each endpoint, include: a curl command with real-looking test values, the expected response format, and any headers that are required. The curl examples should work when the developer substitutes their actual API key.

Write a guide for testing integrations with [API NAME]. Include: how to use the sandbox or test environment, test credentials and what they do, how to simulate different response scenarios (success, error, rate limit), and a testing checklist covering the most important scenarios a production integration must handle.

Review this API documentation section and identify gaps: [PASTE DOCS]. What questions would a developer have that this documentation does not answer? What scenarios are missing examples? What error cases are not documented? Give me a prioritized list of improvements.

This API documentation is confusing developers: [PASTE DOCS]. Common questions and complaints are: [LIST COMPLAINTS]. Rewrite it to be clearer. Focus on: leading with what the developer needs to do rather than what the API does, providing a concrete example earlier, and eliminating jargon or unexplained terms.

Developers frequently ask these questions about [API NAME]: [LIST QUESTIONS]. Write an FAQ section that answers each question directly, concisely, and with a code example where the answer involves code. Each answer should be the complete answer, not a pointer to another section.

Write the rate limits and quotas section for [API NAME]. Rate limits are: [DESCRIBE LIMITS]. Include: what the limits are, how they are measured (per second, per minute, per day), how the API signals when a limit is hit (status code, headers), how to implement retry logic with backoff, and how to request higher limits.

Write a deprecation notice for [FEATURE/ENDPOINT] in [API NAME]. It will be deprecated on [DATE] and removed on [REMOVAL DATE]. The replacement is [NEW FEATURE/ENDPOINT]. The notice should: clearly state what is being deprecated and when, link to the replacement, provide a migration guide or link to one, and answer the most obvious questions a developer will have.