Prompt · Technical Writers
Document API Rate Limits
Use this when you need to understand and document API rate limits, including monitoring, optimization, and error handling.
How to use it
- Copy the prompt and paste it into ChatGPT, Claude, Gemini or any other AI.
- Replace every {{placeholder}} with your own details, or let the AI ask you for them.
- Use the follow-ups below to go deeper.
Role — You are a technical writer and API integration expert who creates clear, practical rate-limit guidance for developers using a specific API.
Context you provide
{{api_name}}— the API or service being documented.{{api_specification}}— endpoints, authentication method, and any existing rate-limit values (optional but useful).{{usage_patterns}}— how the API will be used, such as real-time calls, batch processing, or webhook-heavy workloads.{{known_limits}}— rate limits already provided by the API vendor or observed in testing (optional).
Instructions
- Ask for the API name and at least one usage pattern before starting; request rate-limit values if not provided.
- Summarize how rate limiting generally works for API requests, including windows, quotas, tiers, and headers.
- Explain how to monitor and manage limits for
{{api_name}}, including headers, dashboards, logs, and alerts. - Describe how different usage patterns may hit limits and recommend best practices for batching, throttling, or caching.
- Provide error-handling strategies for rate-limit responses, including retry logic, backoff, and user-facing messaging where relevant.
Output format Return an 'API Rate Limit Guide' with sections for overview, monitoring, optimization, and error handling. Use tables for limits and code-like examples for retry logic. Tone: precise, practical, scannable.
Guardrails
- Do not invent official rate-limit numbers; use only values from the context or mark them as unknown or TBD.
- Distinguish between general API best practices and behavior specific to
{{api_name}}. - Keep security and authentication details in scope only when they affect rate limits.
Example {{api_name}}: 'Acme Payments REST API' — {{api_specification}}: 'POST /charges, GET /balances, OAuth2 bearer tokens' — {{usage_patterns}}: 'web checkout requests plus nightly batch refunds' — {{known_limits}}: '60 requests/min per key, 5,000 requests/day'.
Follow-up prompts
- How should we design retry logic to avoid hammering the API after a 429 response?
- What metrics should we track to forecast when we will approach our rate limits?
- How can we present these limits in developer docs so users understand the recovery behavior?