Error Response Format
All errors follow a consistent JSON format:HTTP Status Codes
2xx Success
The request was successful. Response includes the requested data.
4xx Client Errors
The request was malformed or contains invalid parameters.Common causes:How to fix:
- Missing required parameters
- Invalid JSON in request body
- Invalid parameter values
- Invalid data types
- Field length violations
- Check that all required parameters are included
- Validate JSON syntax
- Verify parameter values match the expected format
- Review field length requirements in the API docs
Authentication failed or API key is invalid.Common causes:How to fix:
- Missing Authorization header
- Invalid API key format
- Inactive or deleted API key
- Expired API key
- Verify the Authorization header is included:
Authorization: Bearer YOUR_KEY - Check that the API key is correct
- Confirm the API key is active in your dashboard
- Create a new API key if necessary
The API key doesn’t have permission to access the resource.Common causes:Insufficient quota example:How to fix:
- API key lacks team permissions
- Workspace subscription is inactive
- Insufficient API request quota
- Attempting to access another workspace’s resources
- Update API key permissions to include the required teams
- Check your workspace subscription status
- Purchase additional API requests if quota is exhausted
- Verify you’re accessing resources in your workspace
The requested resource doesn’t exist.Common causes:How to fix:
- Invalid resource ID
- Resource was deleted
- Typo in the endpoint URL
- Resource belongs to a different workspace
- Verify the resource ID is correct
- Check if the resource was deleted
- Confirm the endpoint URL is correct
- Ensure the resource exists in your workspace
Rate limit exceeded (20 requests per minute).The response includes a Response headers:How to fix:
Retry-After header indicating how long to wait before retrying.- Implement exponential backoff
- Respect the
Retry-Afterheader - Use request queuing
- Leverage batch endpoints to reduce request count
- See Rate Limiting for detailed strategies
5xx Server Errors
An unexpected error occurred on the server.How to fix:
- Retry the request after a short delay
- Contact support if the problem continues
Common Error Scenarios
Authentication Errors
Validation Errors
Permission Errors
Resource Errors
Quota Errors
Variation Errors
Batch Operation Errors
Error Handling Best Practices
Retry Strategy
Implement intelligent retry logic with exponential backoff:Comprehensive Error Handler
User-Friendly Messages
Map technical errors to user-friendly messages:Logging and Monitoring
Track errors to identify patterns and issues:Need Help?
If you’re experiencing persistent errors:Support
Contact our support team
Documentation
Review the full API documentation