What is Solve API?
The Solve API lets you use our product's features to create custom bots, automate support tasks, and add search functions to your help center. It's designed to be flexible and powerful, helping developers add advanced search and chat features to different systems. It supports various response types (e.g., text, HTML, and markdown), and works independently of existing email and widget workflows.
Admin Dashboard
In the admin dashboard, you can manage API-related functionalities:
- Channels: See and manage the API channel by navigating to Workflow Builder > API tab.
- Workflows: Create, edit, and delete workflows in the API channel.
- Configuration: View and refresh the API token.
Metrics
The same set of widget metrics will apply to the API channel.
Setup
1. Generate an API Token. To generate a token, follow these steps:
-
- Click Solve > Widget Configuration > API tab.
- Click Generate Key.
2. Navigate to Workflow Builder > API tab.
3. Open a workflow. If you don’t have a workflow, click + New Intent. For more information on creating intents, see How to create custom intents in Workflow Builder and Getting Started with Autoflows.
4. Customize your workflow in either Classic or Autoflows.
Note: Changes made in the workflow will not affect the same workflow under the Widget and Email tabs.
5. At the top-right side of your workflow, click Preview.
6. Toggle the switch to activate or deactivate streaming. Our API supports two modes: streaming and non-streaming. In non-streaming mode, the backend responds only when the response contains all the information. In streaming mode, the backend responds to the front end as soon as some information becomes available. If you want lower latency, it's better to enable streaming.
7. Type a query related to your workflow.
8. On the right side of your screen, you will see the API response.
9. Verify that the workflow is built correctly and understand how the API works. For more information on how the Solve API works on the developer’s side, see Solve API Developer Reference.
10. Use the generated API token to start using the APIs.