Synthflow AI
synthflow_aiSynthflow AI provides AI-powered voice agents to automate both inbound and outbound calls, enhancing customer engagement and operational efficiency.
Acciones disponibles (11)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create AssistantSYNTHFLOW_AI_CREATE_ASSISTANTAcciónTool to create a new assistant. use when you need to initialize a custom voice assistant with specific prompt, llm, language, and voice settings.
SYNTHFLOW_AI_CREATE_ASSISTANTAcciónTool to create a new assistant. use when you need to initialize a custom voice assistant with specific prompt, llm, language, and voice settings.
Parámetros de entrada
llmstringObligatorioLanguage model identifier to power the assistant. Typically 'synthflow'.
namestringObligatorioName of the assistant.
typestringObligatorioenumType of assistant to create.
outboundinboundpromptstringObligatorioInitial prompt or script the assistant will use to start the conversation.
languagestringObligatorioLocale code for the assistant's language.
voice_idstringObligatorioIdentifier of the voice to use for text-to-speech.
consent_textstringCustom message to ask for recording consent.
is_recordingbooleanWhether the conversation should be recorded. If true, logs will be available.
phone_numberstringOptional phone number to call when initiating the assistant.
caller_id_numberstringOptional custom caller ID number for outbound calls.
greeting_messagestringObligatorioGreeting message the assistant will say when starting a call.
consent_recordingbooleanIf true, the assistant will ask for consent before recording.
external_webhook_urlstringuriWebhook URL to receive call data such as transcripts.
is_transcript_disabledbooleanDisable transcription of the call. Defaults to false.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete an assistantSYNTHFLOW_AI_DELETE_ASSISTANTAcciónTool to delete an existing ai assistant. use after confirming the assistant id. example: delete assistant with id 'assistant 123'.
SYNTHFLOW_AI_DELETE_ASSISTANTAcciónTool to delete an existing ai assistant. use after confirming the assistant id. example: delete assistant with id 'assistant 123'.
Parámetros de entrada
model_idstringObligatorioUnique identifier of the assistant to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get AI assistant detailsSYNTHFLOW_AI_GET_ASSISTANTAcciónTool to retrieve details of a specific ai assistant. use after confirming the assistant's id to fetch its configuration and metadata.
SYNTHFLOW_AI_GET_ASSISTANTAcciónTool to retrieve details of a specific ai assistant. use after confirming the assistant's id to fetch its configuration and metadata.
Parámetros de entrada
model_idstringObligatorioUnique identifier of the AI assistant to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get knowledge baseSYNTHFLOW_AI_GET_KNOWLEDGE_BASEAcciónTool to retrieve details of a specific knowledge base by its id. use after confirming the knowledge base id to fetch its metadata.
SYNTHFLOW_AI_GET_KNOWLEDGE_BASEAcciónTool to retrieve details of a specific knowledge base by its id. use after confirming the knowledge base id to fetch its metadata.
Parámetros de entrada
knowledge_base_idstringObligatorioUnique identifier of the knowledge base to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get phone numbersSYNTHFLOW_AI_GET_NUMBERSAcciónTool 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.
SYNTHFLOW_AI_GET_NUMBERSAcciónTool 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.
Parámetros de entrada
limitintegerNumber of phone numbers per page (defaults to 50)
offsetintegerZero-based index of first phone number to return (defaults to 0)
workspacestringObligatorioUnique identifier of the workspace to list phone numbers for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get team detailsSYNTHFLOW_AI_GET_TEAMAcciónTool to retrieve details of a specific team by its id. use after confirming the team exists to inspect its configuration.
SYNTHFLOW_AI_GET_TEAMAcciónTool to retrieve details of a specific team by its id. use after confirming the team exists to inspect its configuration.
Parámetros de entrada
team_idstringObligatorioUnique identifier of the team to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List AI assistantsSYNTHFLOW_AI_LIST_ASSISTANTSAcciónTool to list all ai assistants associated with the account. use when you need to retrieve a paginated list of assistants.
SYNTHFLOW_AI_LIST_ASSISTANTSAcciónTool to list all ai assistants associated with the account. use when you need to retrieve a paginated list of assistants.
Parámetros de entrada
limitintegerNumber of assistants to return per page (defaults to 20 if omitted).
offsetstringCursor for pagination; starting point for returning assistants (defaults to '0').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create a new teamSYNTHFLOW_AI_SYNTHFLOW_AI_CREATE_TEAMAcciónTool to create a new team. use when you need to programmatically set up a synthflow ai assistant group with routing rules.
SYNTHFLOW_AI_SYNTHFLOW_AI_CREATE_TEAMAcciónTool to create a new team. use when you need to programmatically set up a synthflow ai assistant group with routing rules.
Parámetros de entrada
namestringObligatorioUnique name for the new team assistant
phone_numberstringPhone number in E.164 format for voice integration; required only if voice integration is enabled
lead_assistantstringObligatorioModel ID of the lead assistant for this team
external_webhook_urlstringuriHTTPS endpoint to receive post-call data
sub_assistants_attachobject[]List of sub-assistants with routing rules to attach to the team
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete a teamSYNTHFLOW_AI_SYNTHFLOW_AI_DELETE_TEAMAcciónTool 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.
SYNTHFLOW_AI_SYNTHFLOW_AI_DELETE_TEAMAcciónTool 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.
Parámetros de entrada
team_idstringObligatorioID of the team to delete, copyable from the UI
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update an existing teamSYNTHFLOW_AI_SYNTHFLOW_AI_UPDATE_TEAMAcciónTool to update an existing team. use after confirming the team exists and you have new configuration values.
SYNTHFLOW_AI_SYNTHFLOW_AI_UPDATE_TEAMAcciónTool to update an existing team. use after confirming the team exists and you have new configuration values.
Parámetros de entrada
namestringNew display name for the team assistant
team_idstringObligatorioIdentifier of the team to update
phone_numberstringPhone number in E.164 format for voice integration
external_webhook_urlstringuriHTTPS endpoint to receive post-call data
sub_assistants_attachobject[]List of sub-assistants to attach with routing logic
sub_assistants_detachobject[]List of sub-assistants to detach by model ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update AssistantSYNTHFLOW_AI_UPDATE_ASSISTANTAcciónTool to update an existing assistant’s settings. use after confirming the assistant exists. modify settings like name, phone, recording, webhook, or agent configuration.
SYNTHFLOW_AI_UPDATE_ASSISTANTAcciónTool to update an existing assistant’s settings. use after confirming the assistant exists. modify settings like name, phone, recording, webhook, or agent configuration.
Parámetros de entrada
namestringNew name for the assistant
agentobjectPartial assistant configuration object
assistant_idstringObligatorioUnique ID of the assistant to update
consent_textstringCustom consent prompt text; required if consent_recording is true
is_recordingbooleanWhether to record calls; if omitted retains current setting
max_durationobjectMaximum call duration settings
phone_numberstringPhone number for outbound calls, e.g. +15551234567
caller_id_numberstringCustom caller ID number to display, e.g. +12345678901
consent_recordingbooleanIf true, ask caller for consent before recording
external_webhook_urlstringuriWebhook URL to receive call events and transcripts
is_transcript_disabledbooleanDisable transcription if true; defaults to false, transcripts will be generated unless explicitly disabled
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not