Ai

Convolo ai

Learn how to use Convolo ai with Composio

Overview

SLUG: CONVOLO_AI

Description

Convolo.ai is an AI-powered communications platform designed to enhance sales calls and improve conversion rates through rapid lead response and integration capabilities.

Authentication Details

generic_api_key
stringRequired

Connecting to Convolo ai

Create an auth config

Use the dashboard to create an auth config for the Convolo ai toolkit. This allows you to connect multiple Convolo ai accounts to Composio for agents to use.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Convolo ai Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4convolo_ai_auth_config_id = "ac_YOUR_CONVOLO_AI_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Convolo ai for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, convolo_ai_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Convolo ai toolkit’s playground](https://app.composio.dev/app/Convolo ai)

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["CONVOLO_AI"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Character

Description

Tool to create a new character. Use when you have name, voice type, backstory, and optional actions ready.

Action Parameters

actions
array
backstory
stringRequired
charName
stringRequired
voiceType
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Define or Update Character Actions

Description

Tool to define or update the list of actions a character can perform. Use when you need to configure or adjust character capabilities before deployment.

Action Parameters

actions
array
backstory
string
charID
stringRequired
charName
string
languageCodes
array
voiceType
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Evaluate Character Performance

Description

Tool to evaluate a character's performance based on interactions. Use after fetching a conversation session and constructing your prompt.

Action Parameters

character_id
stringRequired
prompt
stringRequired
session_id
stringRequired
variables
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Generate Starter Conversation

Description

Tool to generate starter conversation suggestions for a character. Use when you need opening or follow-up dialogue lines.

Action Parameters

charId
stringRequired
sessionId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Character Response

Description

Tool to generate a response from a ConvAI character based on text or audio input. Use when needing a text or voice reply in an ongoing session.

Action Parameters

charID
stringRequired
file
string
sample_rate
string
sessionID
stringRequired
stream
string
userText
string
voiceResponse
booleanRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Voices

Description

Tool to retrieve the list of available voice types. Use when selecting voices before generating speech.

Action Parameters

accept
string
contentType
string
use_alt_domain
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Set Core AI Settings

Description

Tool to set core AI settings for a character. Use after confirming character existence.

Action Parameters

charID
stringRequired
model_group_name
string
temperature
number

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Character Backstory

Description

Tool to update a character's backstory. Use when you need to modify the backstory of an existing character after confirming its ID. Only the provided fields will be updated.

Action Parameters

action
string
backstory
string
charID
stringRequired
charName
string
languageCodes
array
voiceType
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Character

Description

Tool to update existing character details. Use when you have a character ID and need to modify its attributes.

Action Parameters

action
string
backstory
string
charID
stringRequired
charName
string
languageCodes
array
voiceType
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Upload Knowledge Bank File

Description

Tool to upload a knowledge bank file. Use when you have a file ready to add to Convolo AI's knowledge bank (Enterprise plan only).

Action Parameters

file
stringRequired
file_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired