Add document to knowledge base source
Tool to add a document to a knowledge base source. Use when you need to attach PDF files, web pages, or text content to an existing knowledge base.
ActionTry it
Integrate Synthflow AI
with your AI workspace
Synthflow AI provides AI-powered voice agents to automate both inbound and outbound calls, enhancing customer engagement and operational efficiency.
Explore Triggers and Actions
Attach Actions to Agent
Tool 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.
ActionTry it
Attach contact to memory store
Tool 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.
ActionTry it
Attach knowledge base to agent
Tool 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.
ActionTry it
Attach memory store to agent
Tool 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.
ActionTry it
Create a contact
Tool to create a new contact in Synthflow AI. Use when you need to add a contact with name and phone number.
ActionTry it
Create a new simulation suite
Tool 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.
ActionTry it
Create a new team
Tool to create a new team. Use when you need to programmatically set up a Synthflow AI assistant group with routing rules.
ActionTry it
Create a simulation scenario
Tool to create a new simulation scenario. Use when you need to define a template for generating test cases to ensure coverage of specific situations.
ActionTry it
Create Action
Tool 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.
ActionTry it
Create Assistant
Tool to create a new assistant. Use when you need to initialize a Synthflow AI assistant by specifying its name, type, and agent configuration.
ActionTry it
Create knowledge base
Tool 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.
ActionTry it
Create memory store
Tool 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.
ActionTry it
Create Phone Book
Tool to create a new phone book. Use when you need to create a contact list for organizing phone numbers in Synthflow AI.
ActionTry it
Create phone book entry
Tool 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.
ActionTry it
Create Simulation Case
Tool to create a new simulation case. Use when you need to set up test scenarios for evaluating assistant behavior against defined success criteria.
ActionTry it
Delete a chat session
Tool to delete a chat session. Use when you need to remove an existing chat by its ID. Confirm the chat ID before calling.
ActionTry it
Delete a contact
Tool to delete an existing contact. Use after confirming the contact ID.
ActionTry it
Delete a knowledge base source
Tool 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.
ActionTry it
Delete a memory store
Tool to delete a memory store. Use when you need to remove a memory store after confirming its ID.
ActionTry it
Delete a phone book
Tool 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.
ActionTry it
Delete a phone book entry
Tool 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.
ActionTry it
Delete a simulation case
Tool to delete a simulation case by ID. Use after confirming the simulation case ID to remove it permanently.
ActionTry it
Delete a simulation scenario
Tool to delete an existing simulation scenario. Use after confirming the scenario ID. Example: Delete simulation scenario with ID '41fc8c4a-b372-4309-813a-545505b2d0e5'.
ActionTry it
Delete a simulation suite
Tool 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.
ActionTry it
Delete a subaccount
Tool to delete an existing subaccount. Use after confirming the subaccount ID. Example: Delete subaccount with ID 'test_subaccount_id_12345'.
ActionTry it
Delete a team
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.
ActionTry it
Delete an action
Tool to delete an existing action. Use after confirming the action ID to permanently remove it.
ActionTry it
Delete an assistant
Tool to delete an existing AI assistant. Use after confirming the assistant ID. Example: Delete assistant with ID 'assistant_123'.
ActionTry it
Delete knowledge base
Tool to delete an existing knowledge base. Use after confirming the knowledge base ID to permanently remove it.
ActionTry it
Detach actions from assistant
Tool to detach one or more actions from an AI assistant. Use when you need to remove specific actions from an agent's configuration.
ActionTry it
Detach contact from memory store
Tool to detach a contact from a memory store. Use when you need to remove a contact from a specific memory store.
ActionTry it
Detach knowledge base
Tool to detach a knowledge base from an AI assistant. Use when you need to remove a knowledge base association from an agent.
ActionTry it
Detach memory store from agent
Tool to detach a memory store from an agent. Use when you need to remove a memory store from a specific agent/assistant.
ActionTry it
Execute simulation suite
Tool 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.
ActionTry it
Export analytics data
Tool 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.
ActionTry it
Get action metadata
Tool to retrieve metadata about a specific action by its ID. Use when you need to inspect an action's configuration and parameters.
ActionTry it
Get AI assistant details
Tool to retrieve details of a specific AI assistant. Use after confirming the assistant's ID to fetch its configuration and metadata.
ActionTry it
Get contact details
Tool to retrieve details of a specific contact by its ID. Use when you need to fetch contact information.
ActionTry it
Get knowledge base
Tool to retrieve details of a specific knowledge base by its ID. Use after confirming the knowledge base ID to fetch its metadata.
ActionTry it
Get memory store
Tool 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.
ActionTry it
Get memory store contact data
Tool to retrieve memory data for a specific contact in a memory store. Use when you need to fetch stored memory information associated with a particular contact.
ActionTry it
Get phone call details
Tool 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.
ActionTry it
Get phone numbers
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.
ActionTry it
Get Simulation Case
Tool 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.
ActionTry it
Get simulation details
Tool 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.
ActionTry it
Get simulation scenario
Tool to retrieve a simulation scenario by ID. Use when you need to fetch details of a specific simulation scenario template.
ActionTry it
Get simulation suite by ID
Tool 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.
ActionTry it
Get subaccount details
Tool to retrieve detailed metadata about a specific subaccount by ID. Use when you need to fetch subaccount information including permissions, subscription details, and members.
ActionTry it
Get team details
Tool to retrieve details of a specific team by its ID. Use after confirming the team exists to inspect its configuration.
ActionTry it
Initialize Action
Tool to initialize a custom action with specified variables. Use when you have an action ID and need to initialize it with configuration variables.
ActionTry it
List actions
Tool to list all actions in the workspace. Use when you need to retrieve a paginated list of available actions and their configurations.
ActionTry it
List AI assistants
Tool to list all AI assistants associated with the account. Use when you need to retrieve a paginated list of assistants.
ActionTry it
List call history
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.
ActionTry it
List chats
Tool to retrieve a list of chats, optionally filtered by agent ID. Use when you need to view chat history or check recent conversations.
ActionTry it
List contacts
Tool to retrieve a list of contacts with optional search filtering. Use when you need to list all contacts or search for specific contacts by phone number.
ActionTry it
List memory stores
Tool to list memory stores with optional filtering by title. Use when you need to retrieve all memory stores in a workspace, optionally filtered by search term.
ActionTry it
List Phone Books
Tool to list all phone books in your workspace. Use when you need to retrieve all phone books for organizing contacts in Synthflow AI.
ActionTry it
List Simulation Cases
Tool 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.
ActionTry it
List simulation cases by agent
Tool to list all simulation cases created for a specific agent. Use when you need to retrieve test scenarios associated with a particular agent ID.
ActionTry it
List simulation scenarios
Tool 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.
ActionTry it
List simulation sessions
Tool 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.
ActionTry it
List simulation suites
Tool 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.
ActionTry it
List simulations
Tool 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.
ActionTry it
List subaccounts
Tool to list all subaccounts associated with the authenticated account. Use when you need to retrieve all subaccounts and their configurations.
ActionTry it
List teams
Tool to list assistant teams. Use when you need to retrieve all teams in a workspace.
ActionTry it
List voices
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.
ActionTry it
List webhook logs
Tool 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.
ActionTry it
Make a voice call
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.
ActionTry it
Start Simulation
Tool 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.
ActionTry it
Update a contact
Tool to update an existing contact in Synthflow AI. Use when you need to modify contact details like name, phone, email, or metadata.
ActionTry it
Update a simulation scenario
Tool to update an existing simulation scenario. Use when you need to modify the name or description of a scenario template.
ActionTry it
Update Action
Tool 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.
ActionTry it
Update an existing simulation suite
Tool 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.
ActionTry it
Update an existing team
Tool to update an existing team. Use after confirming the team exists and you have new configuration values.
ActionTry it
Update Assistant
Tool to update an existing assistant’s settings. Use after confirming the assistant exists. Modify settings like name, phone, recording, webhook, or agent configuration.
ActionTry it
Update knowledge base
Tool to update an existing knowledge base's name or usage conditions. Use after confirming the knowledge base exists.
ActionTry it
Update memory store
Tool to update an existing memory store's title and description. Use when you need to modify metadata of a memory store.
ActionTry it
Update Simulation Case
Tool to update an existing simulation case. Use when you need to modify the name, prompt, success criteria, or evaluation method of a simulation case.
ActionTry it