Skip to main content
Synthflow AI logo
  • Category: ai agents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 79
  • Triggers: 0
  • Slug: SYNTHFLOW_AI
  • Version: 20261101_00

Tools

Slug: SYNTHFLOW_AI_ADD_KB_SOURCE_DOCUMENTAdd a document source to an existing knowledge base using a hosted PDF URL, a web page URL, or text content.

Input Parameters

string
Required for ‘pdf’ or ‘web’ types. Hosted PDF URL or website URL to scrape
string
required
Source identifier or display name for the document
string ("pdf" | "text" | "web")
required
Type of document source: ‘pdf’ for hosted PDF files, ‘text’ for plain text content, or ‘web’ for website URLs
string
Required for ‘text’ type. Contains the full text content of the document
string
required
Unique identifier of the knowledge base to add the document to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_ATTACH_ACTIONS_TO_AGENTTool to attach one or more actions to an agent. Use when you need to configure an agent with specific actions by providing the agent’s model_id and an array of action IDs.

Input Parameters

array
required
Array of action IDs to attach. To find an action’s ID, go to its page in your Synthflow dashboard
string
required
The ID of the agent you want to attach an action to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_ATTACH_CONTACT_TO_MEMORY_STORETool to attach a contact to a memory store. Use when you need to associate a specific contact with a memory store for persistent data storage.

Input Parameters

string
required
The unique identifier of the contact to attach to the memory store
string
required
The unique identifier of the memory store to attach the contact to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_ATTACH_KNOWLEDGE_BASE_TO_AGENTTool to attach a knowledge base to an agent. Use when you need to connect a knowledge base to a specific AI assistant by providing both IDs.

Input Parameters

string
required
ID of the agent to which knowledge base needs to be attached
string
required
The identifier for the knowledge base being attached

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_ATTACH_MEMORY_STORE_TO_AGENTTool to attach a memory store to an agent. Use when you need to connect a memory store resource to a specific assistant for knowledge retrieval.

Input Parameters

string
required
The agent’s model ID to attach the memory store to
string
required
The memory store ID to attach

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_CREATE_ACTIONTool to create a new action in Synthflow AI. Use when you need to configure an action such as real-time booking, information extraction, live transfer, SMS sending, custom HTTP calls, or custom evaluations. Exactly one action type must be specified in the request.

Input Parameters

object
Send SMS action configuration.
object
Custom evaluation action configuration.
object
Custom action configuration for HTTP API calls.
object
Live transfer action configuration.
object
Real-time booking action configuration.
object
Information extractor action configuration. Can be YES_NO, SINGLE_CHOICE, or OPEN_QUESTION type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_CREATE_ASSISTANTTool to create a new assistant. Use when you need to initialize a Synthflow AI assistant by specifying its name, type, and agent configuration.

Input Parameters

string
required
Name of the assistant.
string ("outbound" | "inbound" | "widget")
required
Type of assistant to create. Note: ‘outbound’ type typically requires phone_number and caller_id_number.
object
required
Assistant configuration object. At least one sub-parameter must be provided. Examples include ‘voice_id’. Additional supported fields may be included per API docs.
string
Assistant description.
boolean
Whether to record the conversation.
object
Maximum call duration settings.
string
Phone number attached to the agent. Required for type=‘outbound’ and typically required for type=‘inbound’.
string
Caller ID number to display when making outbound calls. Required for type=‘outbound’.
string
HTTPS URL to receive post-call data (e.g., transcript).
string
HTTPS URL to receive inbound call webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_CREATE_CONTACTTool to create a new contact in Synthflow AI. Use when you need to add a contact with name and phone number.

Input Parameters

string
required
The contact’s full name
string
The contact’s email address
string
required
The contact’s phone number in E.164 format (e.g., +15551234567)
object
Additional metadata for the contact as key-value pairs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_CREATE_KNOWLEDGE_BASETool to create a new knowledge base and return its ID. Use when you need to set up a knowledge repository for retrieval-augmented generation (RAG) in assistants.

Input Parameters

string
required
Designation for the knowledge base
string
Specifies when this knowledge base should be activated during conversations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_CREATE_MEMORY_STORETool to create a new memory store. Use when you need to initialize a knowledge repository for storing conversation history, customer data, or other contextual information.

Input Parameters

string
required
The name for the memory store
string
A brief explanation of the memory store’s purpose

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_CREATE_PHONE_BOOKTool to create a new phone book. Use when you need to create a contact list for organizing phone numbers in Synthflow AI.

Input Parameters

string
required
Phone book name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_CREATE_PHONE_BOOK_ENTRYTool to create a phone book entry. Use when you need to add a new phone number with a transfer condition to an existing phone book.

Input Parameters

string
required
Phone number to add to the phone book in E.164 format (e.g., +12025551234).
string
required
Unique identifier of the phone book where the entry will be created.
string
required
Condition that triggers the transfer to this phone number (e.g., ‘When the caller asks for a sales representative’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_CREATE_SIMULATION_CASETool to create a new simulation case. Use when you need to set up test scenarios for evaluating assistant behavior against defined success criteria.

Input Parameters

string
required
Name of the simulation case for identification
string ("custom" | "agent_based")
required
Type of simulation case - ‘custom’ for manual scenarios or ‘agent_based’ to derive from an existing agent
string
required
Instructions or scenario that will be used during the simulation
string
Optional agent ID to base the generated simulation case upon. Required when type is ‘agent_based’
array
required
List of evaluation conditions that define successful simulation execution
string ("all" | "any")
required
Determines if ‘all’ success criteria must pass or ‘any’ single criterion is sufficient

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_CREATE_SIMULATION_SCENARIOTool to create a new simulation scenario. Use when you need to define a template for generating test cases to ensure coverage of specific situations.

Input Parameters

string
required
Label for the simulation scenario template.
string
required
Description of what the scenario template should verify when generating test cases.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_CREATE_SIMULATION_SUITETool to create a new simulation suite attached to a specific agent. Use when you need to set up test scenarios for an agent. The suite can only execute on the agent specified by model_id.

Input Parameters

string
required
Identifier for the simulation suite
string
Locale code (default: en-US); examples include ‘es-ES’, ‘fr-FR’
string
required
Agent model ID this suite is for. The suite can only run on this specific agent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_CREATE_TEAMTool to create a new team. Use when you need to programmatically set up a Synthflow AI assistant group with routing rules.

Input Parameters

string
required
Unique name for the new team assistant
string
Phone number in E.164 format for voice integration; required only if voice integration is enabled
string
required
Model ID of the lead assistant for this team
string
HTTPS endpoint to receive post-call data
array
List of sub-assistants with routing rules to attach to the team

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_ACTIONTool to delete an existing action. Use after confirming the action ID to permanently remove it.

Input Parameters

string
required
Unique identifier of the action to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_ASSISTANTTool to delete an existing AI assistant. Use after confirming the assistant ID. Example: Delete assistant with ID ‘assistant_123’.

Input Parameters

string
required
Unique identifier of the assistant to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_CHATTool to delete a chat session. Use when you need to remove an existing chat by its ID. Confirm the chat ID before calling.

Input Parameters

string
required
Unique identifier of the chat session to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_CONTACTTool to delete an existing contact. Use after confirming the contact ID.

Input Parameters

string
required
Unique identifier of the contact to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_KNOWLEDGE_BASETool to delete an existing knowledge base. Use after confirming the knowledge base ID to permanently remove it.

Input Parameters

string
required
Unique identifier of the knowledge base to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_KNOWLEDGE_BASE_SOURCETool to delete a source from a knowledge base. Use when you need to remove a specific source from a knowledge base after confirming both IDs.

Input Parameters

string
required
Unique identifier of the source to be deleted from the knowledge base
string
required
Unique identifier of the knowledge base containing the source

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_MEMORY_STORETool to delete a memory store. Use when you need to remove a memory store after confirming its ID.

Input Parameters

string
required
The unique identifier of the memory store to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_PHONE_BOOKTool to delete an existing phone book. Use when you need to remove a Synthflow AI phone book after it’s no longer needed. Confirm the phone book ID before calling.

Input Parameters

string
required
Unique identifier of the phone book to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_PHONE_BOOK_ENTRYTool to delete a phone book entry. Use when you need to remove a specific entry from a phone book. Confirm both phone_book_id and entry_id before calling.

Input Parameters

string
required
ID of the specific phone book entry to delete
string
required
ID of the phone book containing the entry to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_SIMULATION_CASETool to delete a simulation case by ID. Use after confirming the simulation case ID to remove it permanently.

Input Parameters

string
required
Unique identifier of the simulation case to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_SIMULATION_SCENARIOTool to delete an existing simulation scenario. Use after confirming the scenario ID. Example: Delete simulation scenario with ID ‘41fc8c4a-b372-4309-813a-545505b2d0e5’.

Input Parameters

string
required
Unique identifier of the simulation scenario to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_SIMULATION_SUITETool to delete a simulation suite by ID. Use when you need to remove a simulation suite that is no longer needed. Confirm the suite ID before calling.

Input Parameters

string
required
The unique identifier of the simulation suite to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_SUBACCOUNTTool to delete an existing subaccount. Use after confirming the subaccount ID. Example: Delete subaccount with ID ‘test_subaccount_id_12345’.

Input Parameters

string
required
Unique identifier of the subaccount to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DELETE_TEAMTool 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.

Input Parameters

string
required
ID of the team to delete, copyable from the UI

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DETACH_ACTIONTool to detach one or more actions from an AI assistant. Use when you need to remove specific actions from an agent’s configuration.

Input Parameters

array
Array of action IDs to detach (IDs found in Synthflow dashboard)
string
required
The ID of the agent you want to detach an action from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DETACH_KNOWLEDGE_BASETool to detach a knowledge base from an AI assistant. Use when you need to remove a knowledge base association from an agent.

Input Parameters

string
required
ID of the agent from which the knowledge base needs to be detached
string
required
Unique identifier of the knowledge base to detach

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DETACH_MEMORY_STORE_CONTACTTool to detach a contact from a memory store. Use when you need to remove a contact from a specific memory store.

Input Parameters

string
required
Unique identifier of the contact to detach from the memory store
string
required
Unique identifier of the memory store from which to detach the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_DETACH_MEMORY_STORE_FROM_AGENTTool to detach a memory store from an agent. Use when you need to remove a memory store from a specific agent/assistant.

Input Parameters

string
required
Unique identifier of the agent (assistant) from which to detach the memory store
string
required
Unique identifier of the memory store to detach from the agent

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_EXECUTE_SIMULATION_SUITETool to execute all test cases in a simulation suite. The suite runs on the target agent (must match the suite’s model_id). Use when you need to validate an agent’s performance against pre-configured test scenarios.

Input Parameters

string
required
UUID identifying the simulation suite to execute
integer
Maximum number of turns per test case. Defaults to 20 if not specified.
string
required
Agent ID to run the suite against. Must correspond to the suite’s existing model_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_EXPORT_ANALYTICSTool to export analytics data for calls within a specified date range. Use when you need to retrieve call analytics, filter by assistant/agent, call type, or time period. Defaults to past 7 days if no dates specified; maximum date range is 120 days.

Input Parameters

string
End date for analytics export in ISO 8601 date-time format (e.g., 2025-11-25T14:30:00Z). Defaults to current time if omitted.
string
Agent identifier to filter analytics for a specific assistant. Can be found on the agent dashboard page.
string
Start date for analytics export in ISO 8601 date-time format (e.g., 2025-11-20T14:30:00Z). Defaults to past 7 days if omitted. Maximum date range is 120 days.
string ("inbound" | "outbound" | "widget")
Type of call for filtering analytics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_ACTIONTool to retrieve metadata about a specific action by its ID. Use when you need to inspect an action’s configuration and parameters.

Input Parameters

string
required
Unique identifier of the action to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_ASSISTANTRetrieve details of a specific Synthflow AI assistant by its model ID.

Input Parameters

string
required
Unique identifier of the AI assistant to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_CALLTool to retrieve the transcript and detailed metadata for a specific phone call. Use when you need to access call recordings, transcripts, duration, or telephony details for a completed call.

Input Parameters

string
required
Unique identifier of the call to retrieve transcript and metadata for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_CONTACTTool to retrieve details of a specific contact by its ID. Use when you need to fetch contact information.

Input Parameters

string
required
Unique identifier of the contact to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_KNOWLEDGE_BASETool to retrieve details of a specific knowledge base by its ID. Use after confirming the knowledge base ID to fetch its metadata.

Input Parameters

string
required
Unique identifier of the knowledge base to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_MEMORY_STORETool to retrieve details of a specific memory store by its ID. Use when you need to fetch metadata and configuration of an existing memory store.

Input Parameters

string
required
Unique identifier of the memory store to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_MEMORY_STORE_CONTACT_DATARetrieve memory data for a specific contact in a memory store. An HTTP 404 is returned as an OK result with empty memory data.

Input Parameters

string
required
Unique identifier of the contact
string
required
Unique identifier of the memory store

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_NUMBERSTool 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.

Input Parameters

integer
Number of phone numbers per page (defaults to 50)
integer
Zero-based index of first phone number to return (defaults to 0)
string
required
Unique identifier of the workspace to list phone numbers for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_SIMULATIONTool to retrieve details of a specific simulation by ID. Use to fetch simulation results including timeline, recording, and success criteria evaluation after a simulation has been executed.

Input Parameters

string
required
Unique identifier of the simulation to retrieve details for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_SIMULATION_CASETool to retrieve a simulation case by ID. Use when you need to fetch details of a specific simulation case including its prompt, success criteria, and metadata.

Input Parameters

string
required
Unique identifier (UUID) of the simulation case to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_SIMULATION_SCENARIOTool to retrieve a simulation scenario by ID. Use when you need to fetch details of a specific simulation scenario template.

Input Parameters

string
required
Unique identifier of the simulation scenario to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_SIMULATION_SUITETool to retrieve a simulation suite by ID. Use when you need to fetch details about a specific simulation suite including its test cases and associated agent information.

Input Parameters

string
required
The unique identifier of the simulation suite to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_SUBACCOUNTTool to retrieve detailed metadata about a specific subaccount by ID. Use when you need to fetch subaccount information including permissions, subscription details, and members.

Input Parameters

string
required
Unique identifier of the subaccount to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_GET_TEAMTool to retrieve details of a specific team by its ID. Use after confirming the team exists to inspect its configuration.

Input Parameters

string
required
Unique identifier of the team to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_INITIALIZE_ACTIONTool to initialize a custom action with specified variables. Use when you have an action ID and need to initialize it with configuration variables.

Input Parameters

string
required
The identifier for the custom action to initialize.
array
Optional array of key-value pairs for action configuration variables.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_ACTIONSTool to list all actions in the workspace. Use when you need to retrieve a paginated list of available actions and their configurations.

Input Parameters

integer
Actions displayed per page (defaults to 20 if omitted).
integer
Index of the first action to be returned (defaults to 0).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_ASSISTANTSList AI assistants associated with the account using pagination parameters. The result contains the assistant list but does not include pagination metadata.

Input Parameters

integer
Number of assistants to return per page (defaults to 20 if omitted).
string
Cursor for pagination; starting point for returning assistants (defaults to ‘0’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_CALLSTool 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.

Input Parameters

integer
Page size (number of call records to return), defaults to 20
integer
Index of the first call to be returned (for pagination), defaults to 0
integer
End timestamp in milliseconds since epoch to filter calls until
string
required
The model/agent identifier whose calls should be returned
integer
Begin timestamp in milliseconds since epoch to filter calls from
string
Filter by status of the call (e.g., ‘completed’, ‘no-answer’, ‘busy’, ‘failed’)
integer
Maximum call duration in seconds to filter by
integer
Minimum call duration in seconds to filter by
string
Phone number in E.164 format to filter calls by (URL-encode leading ’+’ as %2B)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_CHATSTool to retrieve a list of chats, optionally filtered by agent ID. Use when you need to view chat history or check recent conversations.

Input Parameters

integer
Limit the number of chats to return (defaults to 10 if omitted)
string
Cursor to start from for pagination; use next_cursor from previous response
string
Filter chats by agent ID to retrieve only chats associated with a specific agent

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_CONTACTSList contacts with optional phone-number search filtering. The response includes pagination information.

Input Parameters

Optional parameter to search for contacts by phone number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_MEMORY_STORESList memory stores in a workspace, optionally filtered by title. The response includes pagination information.

Input Parameters

string
Filters results by the memory store’s title

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_PHONE_BOOKSList phone books in your workspace for organizing contacts. The response includes pagination information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_SIMULATION_CASESTool to list simulation cases with pagination and optional filtering by name or type. Use when you need to retrieve simulation cases for testing agent behavior.

Input Parameters

string
Filter simulation cases by name (case-insensitive search)
integer
Number of simulation cases to return per page
integer
Page number for pagination, starts at 1
string ("custom" | "agent_based")
Type of simulation case.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_SIMULATION_CASES_BY_AGENTTool to list all simulation cases created for a specific agent. Use when you need to retrieve test scenarios associated with a particular agent ID.

Input Parameters

string
required
Agent ID whose simulation cases to list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_SIMULATIONSTool to list simulations with pagination and optional filters. Use when you need to retrieve simulation records, optionally filtered by session ID, status, date range, or target agent.

Input Parameters

string ("in-progress" | "completed" | "failed")
Status of a simulation.
string
Maximum creation timestamp to filter until (ISO 8601 datetime format).
integer
Number of records per page (defaults to 10).
string
Minimum creation timestamp to filter from (ISO 8601 datetime format).
integer
Pagination page number (defaults to 1).
string
Filter by target agent identifier.
string
Filter by simulation session ID (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_SIMULATION_SCENARIOSTool to list simulation scenarios with pagination and optional filtering. Use when you need to retrieve simulation scenario templates with support for search by name and date range filtering.

Input Parameters

string
Search term for filtering simulation scenario names.
string
Filter scenarios created on or before this date (ISO datetime format).
integer
Number of items per page (defaults to 10).
string
Filter scenarios created on or after this date (ISO datetime format).
integer
Page number for pagination (defaults to 1).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_SIMULATION_SESSIONSTool to list simulation sessions with pagination and optional filters. Use when you need to retrieve simulation sessions, optionally filtered by target agent, date range, or paginated results.

Input Parameters

string
Filter by simulation created_at <= end_date. Use ISO 8601 format (e.g., ‘2024-12-31T23:59:59Z’).
integer
Number of items per page. Defaults to 10.
string
Filter by simulation created_at >= start_date. Use ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’).
integer
Page number for pagination. Defaults to 1.
string
Filter sessions by target agent ID. Only sessions for this agent will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_SIMULATION_SUITESTool to list simulation suites with pagination and optional filtering. Use when you need to retrieve simulation suites, optionally filtered by model IDs, date range, or search term.

Input Parameters

string
Search term for simulation suite names
string
Filter by created_at <= end_date (ISO datetime format)
array
Filter by list of model IDs
integer
Number of items per page (default: 10)
string
Filter by created_at >= start_date (ISO datetime format)
integer
Page number (default: 1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_SUBACCOUNTSTool to list all subaccounts associated with the authenticated account. Use when you need to retrieve all subaccounts and their configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_TEAMSList assistant teams in a workspace. HTTP errors are returned as a status with no team data, rather than raised as request errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_VOICESList text-to-speech voices in a specified workspace, with optional limit and offset pagination.

Input Parameters

integer
Number of voices to return per page (defaults to 50)
integer
Zero-based index of first voice to return (defaults to 0)
string
required
Unique identifier of the workspace to list voices for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_LIST_WEBHOOK_LOGSTool to retrieve paginated webhook logs with filtering and search capability. Use when you need to audit webhook delivery, check webhook statuses, troubleshoot failed webhooks, or search for specific webhook events by date range, status, type, or associated call/assistant.

Input Parameters

string
Search query to filter logs by webhook URL, model ID, or other text fields.
string ("pending" | "success" | "failed")
Status of webhook log processing.
string
Filter logs by associated call identifier.
string
End date filter in ISO 8601 format (e.g., 2025-11-25T14:30:00Z) to retrieve logs up to this date.
string
Start date filter in ISO 8601 format (e.g., 2025-11-20T14:30:00Z) to retrieve logs from this date onwards.
integer
Number of items per page for pagination, defaults to 20 if omitted.
string ("get" | "post" | "put" | "patch" | "delete")
HTTP method for filtering.
integer
Page number for pagination, defaults to 1 if omitted.
string
Filter logs by associated assistant/agent identifier.
string ("external_webhook" | "inbound_webhook" | "custom_action")
Type of webhook for filtering.
string
required
Workspace identifier to retrieve logs for. Required to scope the query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_MAKE_VOICE_CALLTool to initiate a real-time voice call via the AI agent. Use when you have the agent ID, customer name, and phone number ready.

Input Parameters

string
required
Recipient’s full name for personalization.
string
required
Recipient’s phone number in E.164 format (e.g., +15551234567).
string
Optional override of the default agent prompt for this call.
string
Optional override of the greeting the agent will use at call start.
string
required
Agent ID (from your dashboard).
string
Optional customer email for appointment booking or follow-up.
string
Optional customer IANA timezone (e.g., ‘America/Los_Angeles’).
array
Optional list of key–value pairs to inject dynamically into the agent prompt.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_START_SIMULATIONTool to start a new simulation using a simulation case. Use when you need to execute a test scenario against an agent to validate its behavior and performance.

Input Parameters

string
required
Identifier for the agent being tested. Must be a valid UUID.
object
Optional key-value pairs for dynamic test data injection during simulation execution.
string
required
Identifier for the simulation case to execute. Must be a valid UUID.
string
Optional identifier to group related simulations together. Must be a valid UUID if provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_UPDATE_ACTIONTool to update an existing action in Synthflow AI. Use when you need to modify an action’s configuration such as real-time booking, information extraction, live transfer, SMS sending, custom HTTP calls, or custom evaluations. Exactly one action type must be specified in the request along with the action_id.

Input Parameters

object
Send SMS action configuration.
string
required
Unique identifier of the action to update
object
Custom evaluation action configuration.
object
Custom action configuration for HTTP API calls.
object
Live transfer action configuration.
object
Real-time booking action configuration.
object
Information extractor action configuration. Can be YES_NO, SINGLE_CHOICE, or OPEN_QUESTION type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_UPDATE_ASSISTANTTool to update an existing assistant’s settings. Use after confirming the assistant exists. Modify settings like name, phone, recording, webhook, or agent configuration.

Input Parameters

string
New name for the assistant
object
Partial assistant configuration object
string
required
Unique ID of the assistant to update
Custom consent prompt text; required if consent_recording is true
boolean
Whether to record calls; if omitted retains current setting
object
Maximum call duration settings
string
Phone number for outbound calls, e.g. +15551234567
string
Custom caller ID number to display, e.g. +12345678901
If true, ask caller for consent before recording
string
Webhook URL to receive call events and transcripts
boolean
Disable transcription if true; defaults to false, transcripts will be generated unless explicitly disabled

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_UPDATE_CONTACTTool to update an existing contact in Synthflow AI. Use when you need to modify contact details like name, phone, email, or metadata.

Input Parameters

string
The contact’s full name
string
The contact’s email address
string
required
Unique identifier of the contact to update
string
The contact’s phone number in E.164 format (e.g., +15551234567)
object
Additional metadata for the contact as key-value pairs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_UPDATE_KNOWLEDGE_BASETool to update an existing knowledge base’s name or usage conditions. Use after confirming the knowledge base exists.

Input Parameters

string
New designation for the knowledge base
string
required
Unique identifier of the knowledge base to update
string
Specifies when this knowledge base should be utilized during conversations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_UPDATE_MEMORY_STORETool to update an existing memory store’s title and description. Use when you need to modify metadata of a memory store.

Input Parameters

string
New name for the memory store
string
New description for the memory store
string
required
Unique identifier of the memory store to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_UPDATE_SIMULATION_CASETool to update an existing simulation case. Use when you need to modify the name, prompt, success criteria, or evaluation method of a simulation case.

Input Parameters

string
New name for the simulation case
string
New instructions or scenario for the simulation
array
New list of evaluation conditions that define successful simulation execution
string ("all" | "any")
Determines how success criteria are evaluated.
string
required
Unique identifier of the simulation case to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_UPDATE_SIMULATION_SCENARIOTool to update an existing simulation scenario. Use when you need to modify the name or description of a scenario template.

Input Parameters

string
New title for the simulation scenario template
string
Updated description of what the scenario template should verify
string
required
Unique identifier of the simulation scenario to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_UPDATE_SIMULATION_SUITETool to update an existing simulation suite. Use when you need to modify the name or agent model of a simulation suite. At least one of name or model_id must be provided.

Input Parameters

string
New designation for the simulation suite
string
New agent model identifier for the suite
string
required
Unique identifier of the simulation suite to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SYNTHFLOW_AI_UPDATE_TEAMTool to update an existing team. Use after confirming the team exists and you have new configuration values.

Input Parameters

string
New display name for the team assistant
string
required
Identifier of the team to update
string
Phone number in E.164 format for voice integration
string
HTTPS endpoint to receive post-call data
array
List of sub-assistants to attach with routing logic
array
List of sub-assistants to detach by model ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not