API Reference
Rate limits
Request quotas and retry guidance.
Overview
Requests are rate limited per organization and API key to ensure platform stability. Response headers communicate current window usage so clients can backoff proactively.
Aggressive polling of run status is a common cause of throttling; prefer webhooks or SDK wait helpers.
Who should read this
- QA engineers, SREs, platform teams, and developers operating Zof Console and APIs.
When to use this workflow
- Onboarding new team members to Zof terminology and workflows
- Authoring internal runbooks aligned with Console labels
- Designing CI/CD or webhook integrations against documented behavior
Step-by-step procedure
Monitor headers
Log Remaining and Reset on integration responses.
Alert when Remaining < 10% of Limit during CI.
Handle 429
Wait for Retry-After duration.
Retry with exponential backoff and jitter.
Key concepts
- X-RateLimit-Limit
- Maximum requests allowed in the current window.
- X-RateLimit-Remaining
- Requests remaining before throttling.
- X-RateLimit-Reset
- Unix timestamp when the window resets.
Best practices
- Implement exponential backoff with jitter on 429
- Cache list results where appropriate
- Use webhooks instead of polling run status aggressively
Was this page helpful?
