Ai Voice Agents

Synthflow ai

Learn how to use Synthflow ai with Composio

Overview

SLUG: SYNTHFLOW_AI

Description

Synthflow AI provides AI-powered voice agents to automate both inbound and outbound calls, enhancing customer engagement and operational efficiency.

Authentication Details

generic_api_key
stringRequired

Connecting to Synthflow ai

Create an auth config

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

1

Select App

Navigate to [Synthflow ai](https://platform.composio.dev?next_page=/marketplace/Synthflow ai).

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 Synthflow 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
4synthflow_ai_auth_config_id = "ac_YOUR_SYNTHFLOW_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 Synthflow 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, synthflow_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 [Synthflow ai toolkit’s playground](https://app.composio.dev/app/Synthflow ai)

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Create Assistant

Description

Tool to create a new assistant. Use when you need to initialize a Synthflow AI assistant by specifying its name, type, and agent configuration.

Action Parameters

agent
objectRequired
caller_id_number
description
external_webhook_url
inbound_call_webhook_url
is_recording
max_duration
name
stringRequired
phone_number
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create a new team

Description

Tool to create a new team. Use when you need to programmatically set up a Synthflow AI assistant group with routing rules.

Action Parameters

external_webhook_url
lead_assistant
stringRequired
name
stringRequired
phone_number
sub_assistants_attach

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete an assistant

Description

Tool to delete an existing AI assistant. Use after confirming the assistant ID. Example: Delete assistant with ID 'assistant_123'.

Action Parameters

model_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a team

Description

Tool to delete an existing team. Use when you need to remove a Synthflow AI team after it's no longer needed. Confirm the team ID before calling.

Action Parameters

team_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get AI assistant details

Description

Tool to retrieve details of a specific AI assistant. Use after confirming the assistant's ID to fetch its configuration and metadata.

Action Parameters

model_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get knowledge base

Description

Tool to retrieve details of a specific knowledge base by its ID. Use after confirming the knowledge base ID to fetch its metadata.

Action Parameters

knowledge_base_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get phone numbers

Description

Tool to retrieve a list of phone numbers associated with a workspace. Use when you need to fetch numbers assigned to your account for a given workspace.

Action Parameters

limit
offset
workspace
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get team details

Description

Tool to retrieve details of a specific team by its ID. Use after confirming the team exists to inspect its configuration.

Action Parameters

team_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List AI assistants

Description

Tool to list all AI assistants associated with the account. Use when you need to retrieve a paginated list of assistants.

Action Parameters

limit
offset

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List call history

Description

Tool to retrieve call history (call logs) with filtering to check outcomes/statuses after placing calls. Use after making voice calls to list recent calls for a model, filter by phone number/time window, and confirm outcomes like completed/no-answer/busy/failed.

Action Parameters

call_status
duration_max
duration_min
from_date
lead_phone_number
limit
model_id
stringRequired
offset
to_date

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List teams

Description

Tool to list assistant teams. Use when you need to retrieve all teams in a workspace.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List voices

Description

Tool to list all text-to-speech voices in a workspace. Use when you need to retrieve voices available for TTS in a given workspace.

Action Parameters

limit
offset
workspace
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Make a voice call

Description

Tool to initiate a real-time voice call via the AI agent. Use when you have the agent ID, customer name, and phone number ready.

Action Parameters

custom_variables
greeting
lead_email
lead_timezone
model_id
stringRequired
name
stringRequired
phone
stringRequired
prompt

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Assistant

Description

Tool to update an existing assistant’s settings. Use after confirming the assistant exists. Modify settings like name, phone, recording, webhook, or agent configuration.

Action Parameters

agent
assistant_id
stringRequired
caller_id_number
consent_recording
consent_text
external_webhook_url
is_recording
is_transcript_disabled
max_duration
name
phone_number

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update an existing team

Description

Tool to update an existing team. Use after confirming the team exists and you have new configuration values.

Action Parameters

external_webhook_url
name
phone_number
sub_assistants_attach
sub_assistants_detach
team_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired