​
Rate limit

The usage of the Wonderflow API is subject to rate limiting, which applies to each API key and is based on a per-minute basis. Each key has its own limit, and any usage of one key does not affect the limit of a different key.

The rate limit for the Wonderflow API is set at 120 requests per minute with maximum 2 requests per second.

The reason for implementing rate limiting is to ensure that the resources of the Wonderflow API are shared among all clients who access it. This is important to maintain the stability of the network for everyone. Without rate limiting, poorly designed applications or unforeseen circumstances could negatively impact the performance and availability of the network.

If you require an increase in this limit, please contact Wonderflow at help@wonderflow.ai.

​
Versioning and Support

In our REST API suite, we have three distinct versions: v1, v2, and v3, each offering a different set of endpoints to cater to varying needs and functionalities. It’s important to note that not all endpoints are supported across all versions.

​
👉 v3 (latest) 👈

Houses the latest and suggested endpoints with the most up-to-date features and capabilities. Endpoints in v3 represent our current best practices and recommended usage.

​
v2 (maintained)

Includes additional endpoints and features introduced in the second version of our API suite. These endpoints may offer enhanced functionality or improved performance compared to v1.

​
v1 (legacy)

Contains the initial set of endpoints that were introduced with the first version of our API suite. Some endpoints may be considered legacy or foundational in v1.

A detailed Change Log is available from v3.0 onwards, providing information on the updates and enhancements made to the API suite.

​
Status and future deprecation

The v3 version hosts the latest and suggested endpoints that align with our current development standards and practices. Users are encouraged to utilize these endpoints for optimal performance and functionality.

In the future, we plan to deprecate certain endpoints in v1 and v2 versions as we focus on maintaining and enhancing the endpoints available in v3. This deprecation process aims to streamline our API suite and ensure that users leverage the most efficient and effective endpoints.

​
Error Handling

All APIs endpoints return both an HTTP response code and an error message. Typical errors and response codes are shown below.
Check the documentation for the specific APIs with which you are integrating for any API-specific behaviors.

​
Response Code Description

200 - OK: The API request was successful.

201 - Created: The API request was successful in creating an entity.

202 - Accepted: The API request was successfully accepted for asynchronous processing.

400 - Badly formed request: Missing or incorrectly-formed request. Check your request payload format and try again.

401 - Unauthorized: The Bearer token is not valid. Request a new token and try again.

403 - Forbidden: Your access level does not allow for accessing this resource.

404 - Not Found: The identified resource in the URL does not exist/could not be found.

406 - Not Acceptable: The identified acceptable format is not supported. Check that your headers are correct (Accept, Accept-Encoding, Accept-Language), and try again.

429 - Too Many Requests: You have exceeded the rate limit for this API. Wait and try again.

500 - Server Error: Something very unexpected went wrong. These are rare. Check your input values and try again. Open a support ticket with detailed steps to reproduce if needed

If you have any questions or need assistance in navigating the API versions and endpoints, our team is here to support you every step of the way.

Paginationv3 - Get Auth token