Synthflow AI

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.

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.

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.

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.

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.

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.

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

Tool to create a new contact in Synthflow AI. Use when you need to add a contact with name and phone number.

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.

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.

Tool to create a new phone book. Use when you need to create a contact list for organizing phone numbers in Synthflow AI.

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.

Tool to create a new simulation case. Use when you need to set up test scenarios for evaluating assistant behavior against defined success criteria.

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.

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.

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

Tool to delete an existing action. Use after confirming the action ID to permanently remove it.

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

Tool to delete a chat session. Use when you need to remove an existing chat by its ID. Confirm the chat ID before calling.

Tool to delete an existing contact. Use after confirming the contact ID.

Tool to delete an existing knowledge base. Use after confirming the knowledge base ID to permanently remove it.

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.

Tool to delete a memory store. Use when you need to remove a memory store after confirming its ID.

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.

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.

Tool to delete a simulation case by ID. Use after confirming the simulation case ID to remove it permanently.

Tool to delete an existing simulation scenario. Use after confirming the scenario ID. Example: Delete simulation scenario with ID '41fc8c4a-b372-4309-813a-545505b2d0e5'.

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.

Tool to delete an existing subaccount. Use after confirming the subaccount ID. Example: Delete subaccount with ID 'test_subaccount_id_12345'.

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.

Tool to detach one or more actions from an AI assistant. Use when you need to remove specific actions from an agent's configuration.

Tool to detach a knowledge base from an AI assistant. Use when you need to remove a knowledge base association from an agent.

Tool to detach a contact from a memory store. Use when you need to remove a contact from a specific memory store.

Tool to detach a memory store from an agent. Use when you need to remove a memory store from a specific agent/assistant.

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.

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.

Tool to retrieve metadata about a specific action by its ID. Use when you need to inspect an action's configuration and parameters.

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

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.

Tool to retrieve details of a specific contact by its ID. Use when you need to fetch contact information.

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

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.

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.

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.

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.

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.

Tool to retrieve a simulation scenario by ID. Use when you need to fetch details of a specific simulation scenario template.

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.

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.

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

Tool to initialize a custom action with specified variables. Use when you have an action ID and need to initialize it with configuration variables.

Tool to list all actions in the workspace. Use when you need to retrieve a paginated list of available actions and their configurations.

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

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.

Tool to retrieve a list of chats, optionally filtered by agent ID. Use when you need to view chat history or check recent conversations.

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.

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.

Tool to list all phone books in your workspace. Use when you need to retrieve all phone books for organizing contacts in Synthflow AI.

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.

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.