Skip to main content

Overview

Welcome to the API section of Flexibel's documentation. This guide offers an in-depth look at the API functionalities provided by Flexibel, enabling advanced interaction and data management capabilities. The API is organized into two main categories: Chat Routes and Data Routes, each serving distinct purposes within the Flexibel ecosystem. It's crucial to remember that all interactions with the API require a unique API key, which is distinct from the client-side key used for components.

Example Use Cases for the API​

The Flexibel API can be used in a variety of scenarios, such as:

  • Automating Customer Service: By integrating the chat routes into your system, you can automate responses and manage conversations efficiently.
  • Data Integration and Management: The data routes allow for seamless import and management of data sources, ensuring the AI chatbot is well-informed and effective.
  • Custom Analytics and Reporting: Use the API to gather detailed insights into user interactions and data usage, aiding in strategic decision-making.

Features Overview​

Chat Routes​

  • Start, Retrieve, and End Chats: Manage chatbot conversations, including initiation, retrieval, and termination.
  • Message Rating: Retrieve and assign ratings to specific messages for quality control and feedback purposes.

Data Routes​

  • Data Import and Management: Import and manage data sources that the AI chatbot uses to provide informed responses.
  • Source Retrieval and Deletion: Retrieve all data sources for a project and delete specific sources or all sources linked to a project.

Getting Started​

To start utilizing the Flexibel API:

  1. Create an Account and Project: Ensure you have a registered account and a project on Flexibel. This is necessary to obtain your unique API key required for all API interactions.

  2. Navigate to Specific API Sections:

    • For Chat Functionalities: Visit the Chat Routes page for detailed information on managing chatbot interactions.

    • For Data Management: Head over to the Data Routes page to learn about importing, managing, and deleting data used by the AI chatbot.

This overview gives you a roadmap of the capabilities and potential applications of the Flexibel API. Detailed instructions, parameter explanations, and examples for each API route can be found on their respective pages. Remember to handle your API keys with care to ensure the security and integrity of your data and user interactions.