Skip to content

Add rate limiting documentation#311

Draft
rgarcia wants to merge 1 commit intomainfrom
hypeship/add-rate-limiting-docs
Draft

Add rate limiting documentation#311
rgarcia wants to merge 1 commit intomainfrom
hypeship/add-rate-limiting-docs

Conversation

@rgarcia
Copy link
Copy Markdown
Contributor

@rgarcia rgarcia commented Mar 28, 2026

Summary

Adds a new documentation page covering API rate limiting behavior:

  • Rate limits by plan: Documents the per-plan RPM limits (Developer: 10, Hobbyist: 25, Start-Up: 100, Enterprise: 250)
  • Response headers: Documents Retry-After, X-RateLimit-Limit, and X-RateLimit-Remaining headers
  • Retry-After calculation: Explains the token bucket algorithm and how the wait time is derived
  • Example response: Shows a complete 429 response with all headers and JSON body
  • Retry guidance: Practical advice on handling rate limits using the provided headers

The page is added to the Info section in the sidebar navigation, between Pricing and Support.

All details are sourced from the actual implementation in kernel/kernel:

  • packages/api/lib/ratelimit/operations.go — plan defaults, header setting, middleware
  • packages/api/lib/ratelimit/token_bucket.lua — Retry-After calculation
  • packages/api/openapi.yaml — TooManyRequests response schema

Documents the 429 response behavior including Retry-After,
X-RateLimit-Limit, and X-RateLimit-Remaining headers, plan-based
rate limits, and retry guidance.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Mar 28, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Mar 28, 2026, 8:09 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant