Introduction#
The FlowVoice API enables seamless integration with our platform, allowing you to manage voice communication, automate workflows, and access real-time data. This documentation provides the necessary details to authenticate, interact with endpoints, and retrieve structured responses.Base URL#
All API requests should be made to the following base URL:https://api.getflowvoice.com/public
Authentication#
FlowVoice API uses API key authentication. Each request must include the Authorization: Bearer header with a valid API key obtained from your company settings.Example Request#
Rate Limits#
To ensure fair usage, API requests are rate-limited. If the limit is exceeded, the API will return a 429 Too Many Requests response.| Rate Limit | Scope |
|---|
| 100 requests per minute | Globally |
All responses are returned in JSON format. Below is an example of a successful response:{
"status": "success",
"data": {
"id": "12345",
"name": "Example Data"
}
}
Error Handling#
The API returns standard HTTP status codes to indicate success or failure. Common error responses include:| Status Code | Meaning | Description |
|---|
| 400 | Bad Request | The request is malformed or contains invalid parameters. |
| 401 | Unauthorized | API key is missing or invalid. |
| 403 | Forbidden | The API key does not have permission to access the resource. |
| 429 | Too Many Requests | Rate limit exceeded. |
| 500 | Internal Server Error | A problem occurred on FlowVoice’s side. |
Getting Started#
1.
Generate your API key from the FlowVoice dashboard.
2.
Include the Authorization: Bearer in all requests.
3.
Explore the API endpoints to integrate FlowVoice into your system.
Modified at 2025-06-05 13:08:15
