Limits and Best Practices
Rate Limits
To ensure fair usage and platform stability, Biamo Core enforces the following rate limits:
LIMIT TYPE
VALUE
API Requests
100 requests per 15-minute window per API key
If you exceed this limit, your requests will receive a 429 Too Many Requests response with a retryAfterSeconds value.
Handling Rate Limits
Implement exponential backoff when retrying requests after hitting the limit.
Monitor your usage through the rate limit headers included in all responses.
Consider request batching for high-volume operations.
Payload Size Limits
The default Express JSON body parser is used with its standard limits:
PAYLOAD TYPE
MAXIMUM SIZE
Request Body (JSON)
~100KB (default)
Requests exceeding this limit will be rejected with a 413 Payload Too Large error.
Best Practices
Authentication:
Always includex-api-keyandx-project-idheaders in all requests.
Environment Isolation:
Use separate projects for production and testing environments.Validation:
Validate data locally before sending to Biamo Core to reduce errors and improve performance.Webhooks:
Use webhooks for real-time updates instead of polling the API repeatedly.Security:
Store your API keys securely and never expose them in client-side code.
Implement HTTPS for your webhook endpoints.
Keep your API keys private and rotate them periodically.
Performance:
Cache responses where appropriate to reduce API calls.
Implement pagination when retrieving large data sets.
Include only necessary fields in your requests to minimize payload size.