API reference
Errors and limits
HTTP status codes, error bodies, rate limits and daily quotas.
Status codes#
| Status | Meaning | What to do |
|---|---|---|
| 200 | Success | Use overallRecommendation |
| 400 | Invalid request | Fix the body; errors lists the problems |
| 401 | API key unknown or revoked | Check the key |
| 403 | API key missing or not recognised | Send x-api-key |
| 404 | Unknown scenarioId | Check the ID |
| 429 | Rate limit or daily quota reached | Retry with backoff; quota resets daily |
| 5xx | Server error | Retry, then fail open |
Errors have a JSON body:
{ "message": "Validation error", "errors": ["Missing required fields: userData"] }Limits#
| Plan | Checks per day |
|---|---|
| Free | 100 |
| Startup | 500 |
| Growth | 2,000 |
| Enterprise | Custom |
Daily quotas reset at midnight UTC. Bursts are rate-limited per key; the SDK retries 429 and 5xx responses with backoff.