Integrating the Assistant

This page is to detail the process of integrating the Conva.AI assistant to an app.

Conva.AI supports SDKs for the following platforms

Android
Python
iOS
Flutter
Typescript

Integration Modes

There are two ways in which you can add the Conva.AI assistant to your app.

Headless Mode

Integrating the Conva.AI Assistant in Headless mode allows your app to fully control the user interface while using the Assistant's core features. This approach enables direct API calls, response handling, and custom actions, giving you the flexibility to tailor interactions to your specific needs.

Ideal for developers who prefer a custom UI, Headless mode also supports multiple parallel conversations through the Assistant’s Conversational Context feature, offering endless possibilities for personalized user engagement.

For more information on how to integrate the Assistant in headless mode, click here.

Copilot Mode

The Copilot UI is only supported on mobile platforms, currently limited to Android.

If you want to use the Conva.AI Assistant in all its glory, we recommend using the Copilot experience that comes built in.

The Copilot experience includes a well designed bottom sheet that appears on top of the app and provides the following elements:

Text box: For users to type their queries.
Mic icon: To trigger Conva.AI's highly accurate speech recognition feature
Message Area: Displays the message (the message field in the Response object)
Voice Feedback: Speak back the message, can be optionally muted by the user
Mute icon: To allow end-users to enable or disable the voice feedback
Feedback Icons: Automatically appear after each response.
Dynamic Suggestions: Buttons showing related queries (the related_queries field in the Response object) or custom suggestions provided by the app via an API.

Here are the high level steps to use the Copilot:

Setup the Copilot.
- Theme the Copilot
- Register handlers for Agent handling and Suggestion handling
  - Agent Handling: Handle responses generated by the Copilot
  - Suggestion Handling: Handle user interactions with suggestion buttons directed to the app
Attach the Copilot to an Activity
Start the Copilot
Handle the Agents and Suggestion clicks

For more information on how to integrate the Assistant in copilot mode, click here.

PreviousTesting the Assistant NextHeadless Mode

Last updated 4 months ago

Was this helpful?

Integration Modes

There are two ways in which you can add the Conva.AI assistant to your app.

Headless Mode

For more information on how to integrate the Assistant in headless mode, click here.

Copilot Mode

The Copilot UI is only supported on mobile platforms, currently limited to Android.

If you want to use the Conva.AI Assistant in all its glory, we recommend using the Copilot experience that comes built in.

The Copilot experience includes a well designed bottom sheet that appears on top of the app and provides the following elements:

Text box: For users to type their queries.

Mic icon: To trigger Conva.AI's highly accurate speech recognition feature

Message Area: Displays the message (the message field in the Response object)

Voice Feedback: Speak back the message, can be optionally muted by the user

Mute icon: To allow end-users to enable or disable the voice feedback

Feedback Icons: Automatically appear after each response.

Dynamic Suggestions: Buttons showing related queries (the related_queries field in the Response object) or custom suggestions provided by the app via an API.

Here are the high level steps to use the Copilot:

Setup the Copilot.

Theme the Copilot
Register handlers for Agent handling and Suggestion handling
- Agent Handling: Handle responses generated by the Copilot
- Suggestion Handling: Handle user interactions with suggestion buttons directed to the app

Attach the Copilot to an Activity

Start the Copilot

Handle the Agents and Suggestion clicks

For more information on how to integrate the Assistant in copilot mode, click here.