Learn about the basic information the Flow REST API requires to automate the messaging.
Use the Flow REST API to automate messaging with the user (for example, chatbots, voice-powered apps, and devices).
The Flow REST API is designed based on REST principles. It features clear, resource-oriented URLs and utilizes HTTP response codes to indicate errors. We take advantage of built-in HTTP functionalities, such as HTTP authentication and request methods, which are compatible with standard HTTP customers.
Our REST API supports cross-origin resource sharing, which allows you to securely interact with our API from a client-side web application. However, you should never expose your secret API key in any public client-side code. All API responses, including error messages, are returned in JSON format.
The Khoros Care Automation Framework enables you to connect effortlessly with Flow chatbots. For more details, see the About the Automation Framework guide.
The following table provides basic information on automating messaging with the Flow AI engine.
| Parameter Key | Value |
|---|---|
| Host | api.flow.ai |
| Protocols | https |
| Accepts | application/json |
| Responds with | application/json |
Need some inspiration?
You can leverage the Khoros Flow platform in three different ways:
- Tracebuzz connects your social media chat with the messaging platform
- ShopCtrl automates processes for online retailers
- Teleperformance deflects phone calls while automating contact centers
Developers can use the Flow REST API to integrate the Khoros Flow platform into their brand-owned technology stack or solutions.
Some example use cases include:
- Automating a customer experience solution
- Integrating with a custom backend service
- Other server-side integrations
We provide a real-time Flow Socket API for use cases involving client interfaces, such as mobile apps and websites.