# Convolo AI

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

- **Category:** ai sales tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 7
- **Triggers:** 0
- **Slug:** `CONVOLO_AI`
- **Version:** 20260312_00

## Tools

### Create Character

**Slug:** `CONVOLO_AI_CREATE_CHARACTER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `actions` | array | No | Optional list of actions the character can perform. |
| `charName` | string | Yes | Name of the character to create. |
| `backstory` | string | Yes | Background information or story for the character. |
| `voiceType` | string | Yes | Voice type to assign; see Voice List API for available values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Evaluate Character Performance

**Slug:** `CONVOLO_AI_EVALUATE_CHARACTER`

Evaluates a conversation session across 9 quality dimensions (clarity, courtesy, product knowledge, etc.) using AI analysis. Returns structured ratings and feedback. Prerequisites: - A valid session_id from Get Character Response - A character_id from Create Character - Prompt must include [[conversation_history]] placeholder Note: This API requires Professional Plan or higher access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `prompt` | string | Yes | Evaluation instructions that MUST include the placeholder [[conversation_history]]. The conversation history will be automatically fetched and inserted. You can add other placeholders and provide their values via the 'variables' parameter. |
| `variables` | object | No | Optional key-value pairs for custom variables referenced in your prompt (e.g., [[customer_name]], [[product]]). Do NOT include [[conversation_history]] here—it's automatically provided. |
| `session_id` | string | Yes | The ID of the conversation session to evaluate. Obtain this from a Get Character Response action. |
| `character_id` | string | Yes | The ID of the character that will perform the evaluation. Obtain this from a Create Character action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Starter Conversation

**Slug:** `CONVOLO_AI_GENERATE_STARTER_CONVERSATION`

Generates AI-powered conversation starter suggestions for a character. This tool creates contextually relevant opening lines or follow-up dialogue suggestions that can be used to initiate or continue conversations with AI characters. Perfect for chatbots, virtual assistants, game NPCs, or interactive storytelling applications. Use this when you need: - Opening conversation starters for a new interaction (sessionId="-1") - Follow-up suggestions based on an ongoing conversation (provide existing sessionId) - Multiple conversation options to choose from

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `charId` | string | Yes | The unique identifier of the character for which to generate conversation starters. Obtain this from the Create Character action. |
| `sessionId` | string | Yes | The session identifier for context-aware suggestions. Use "-1" to generate opening conversation starters for a new session, or provide an existing session ID for follow-up dialogue suggestions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Character Response

**Slug:** `CONVOLO_AI_GET_CHARACTER_RESPONSE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | string | No | Mono WAV audio file bytes; provide only if not sending userText |
| `charID` | string | Yes | ID of the character to interact with |
| `stream` | string ("True" | "False") | No | Enable SSE streaming; "True" or "False" |
| `userText` | string | No | User text input; provide only if not sending audio |
| `sessionID` | string | Yes | Session identifier; use "-1" to start a new session |
| `sample_rate` | string | No | Sample rate of the uploaded audio in Hz |
| `voiceResponse` | boolean | Yes | Whether to return response audio |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Voices

**Slug:** `CONVOLO_AI_LIST_VOICES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accept` | string | No | Override the Accept header if provided. |
| `contentType` | string | No | Override the Content-Type header if provided. |
| `use_alt_domain` | boolean | No | If true, use https://api.convai.com as base URL instead of default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Core AI Settings

**Slug:** `CONVOLO_AI_SET_CORE_AI_SETTINGS`

Updates the core AI settings (model and/or temperature) for an existing Convai character. Use this action to: - Switch the AI model powering a character (e.g., from GPT-4o to Claude) - Adjust response creativity via temperature parameter (0.0=deterministic, 1.0=creative) - Fine-tune character behavior without recreating the character Prerequisites: Requires a valid charID from a previously created character. At least one of model_group_name or temperature must be specified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `charID` | string | Yes | The unique identifier (charID) of the character to update. Obtain this from CREATE_CHARACTER or character listing endpoints. |
| `temperature` | number | No | Controls response randomness/creativity (0.0-1.0). Lower values (0.0-0.3) make responses more focused and deterministic; higher values (0.7-1.0) increase creativity and variation. Default behavior maintained if not specified. Optional - provide only when adjusting. |
| `model_group_name` | string ("claude-3-5-sonnet" | "gemini-1.5-pro" | "gemini-1.5-flash" | "llama3-70b" | "llama-2-13b" | "gpt-3.5-turbo" | "gpt-4o" | "gpt-4o-mini" | "uncensored-small") | No | AI language model to use for this character. Choose based on desired capabilities: GPT models for general use, Claude for nuanced conversations, Gemini for multimodal, Llama for open-source. Optional - provide only when changing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Knowledge Bank File

**Slug:** `CONVOLO_AI_UPLOAD_KNOWLEDGE_BANK`

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).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | string | Yes | Raw bytes of the knowledge bank file to upload |
| `file_name` | string | Yes | Name of the file being uploaded |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |