Rate Limits & Error Handling

Rate Limits

To ensure fair usage and stability, we have implemented rate limiting on all endpoints.

The default rate limit is 100 requests per minute. Every request will also return with this header to give you a clear idea of requests sent:

Headers Returned:

• X-RateLimit-Limit: The maximum number of requests allowed in a time window.
• X-RateLimit-Remaining: The number of requests remaining in the current time window.
• X-RateLimit-Reset: The time at which the current rate limit window resets.

If you exceed the rate limit, you will receive a 429 Too Many Requests response.

Please contact your SymphonyOS representative if you need an increase in your requests per minute.

Error Handling

Our API uses standard HTTP status codes to indicate the success or failure of a request. Here are some common responses:

• 200 OK: The request was successful.
• 400 Bad Request: The request was invalid or cannot be served.
• 401 Unauthorized: Authentication is required and has failed.
• 403 Forbidden: The request is understood, but it has been refused.
• 404 Not Found: The requested resource could not be found.
• 500 Internal Server Error: An error occurred on the server.

{
  "status": "error",
  "message": "Error message",
  "code": "Error code"
}