# Synthflow AI

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

- **Category:** ai agents
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 79
- **Triggers:** 0
- **Slug:** `SYNTHFLOW_AI`
- **Version:** 20260312_00

## Tools

### Add document to knowledge base source

**Slug:** `SYNTHFLOW_AI_ADD_KB_SOURCE_DOCUMENT`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Required for 'pdf' or 'web' types. Hosted PDF URL or website URL to scrape |
| `name` | string | Yes | Source identifier or display name for the document |
| `type` | string ("pdf" | "text" | "web") | Yes | Type of document source: 'pdf' for hosted PDF files, 'text' for plain text content, or 'web' for website URLs |
| `content` | string | No | Required for 'text' type. Contains the full text content of the document |
| `knowledge_base_id` | string | Yes | Unique identifier of the knowledge base to add the document to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Attach Actions to Agent

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `actions` | array | Yes | Array of action IDs to attach. To find an action's ID, go to its page in your Synthflow dashboard |
| `model_id` | string | Yes | The ID of the agent you want to attach an action to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Attach contact to memory store

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | The unique identifier of the contact to attach to the memory store |
| `memory_store_id` | string | Yes | The unique identifier of the memory store to attach the contact to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Attach knowledge base to agent

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | ID of the agent to which knowledge base needs to be attached |
| `knowledge_base_id` | string | Yes | The identifier for the knowledge base being attached |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Attach memory store to agent

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_id` | string | Yes | The agent's model ID to attach the memory store to |
| `memory_store_id` | string | Yes | The memory store ID to attach |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Action

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `SEND_SMS` | object | No | Send SMS action configuration. |
| `CUSTOM_EVAL` | object | No | Custom evaluation action configuration. |
| `CUSTOM_ACTION` | object | No | Custom action configuration for HTTP API calls. |
| `LIVE_TRANSFER` | object | No | Live transfer action configuration. |
| `REAL_TIME_BOOKING` | object | No | Real-time booking action configuration. |
| `INFORMATION_EXTRACTOR` | object | No | Information extractor action configuration. Can be YES_NO, SINGLE_CHOICE, or OPEN_QUESTION type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Assistant

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a contact

**Slug:** `SYNTHFLOW_AI_CREATE_CONTACT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The contact's full name |
| `email` | string | No | The contact's email address |
| `phone_number` | string | Yes | The contact's phone number in E.164 format (e.g., +15551234567) |
| `contact_metadata` | object | No | Additional metadata for the contact as key-value pairs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create knowledge base

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Designation for the knowledge base |
| `rag_use_condition` | string | No | Specifies when this knowledge base should be activated during conversations |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create memory store

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | The name for the memory store |
| `description` | string | No | A brief explanation of the memory store's purpose |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Phone Book

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Phone book name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create phone book entry

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone_number` | string | Yes | Phone number to add to the phone book in E.164 format (e.g., +12025551234). |
| `phone_book_id` | string | Yes | Unique identifier of the phone book where the entry will be created. |
| `transfer_condition` | string | Yes | Condition that triggers the transfer to this phone number (e.g., 'When the caller asks for a sales representative'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Simulation Case

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a simulation scenario

**Slug:** `SYNTHFLOW_AI_CREATE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Label for the simulation scenario template. |
| `description` | string | Yes | Description of what the scenario template should verify when generating test cases. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new simulation suite

**Slug:** `SYNTHFLOW_AI_CREATE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Identifier for the simulation suite |
| `language` | string | No | Locale code (default: en-US); examples include 'es-ES', 'fr-FR' |
| `model_id` | string | Yes | Agent model ID this suite is for. The suite can only run on this specific agent. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new team

**Slug:** `SYNTHFLOW_AI_CREATE_TEAM`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique name for the new team assistant |
| `phone_number` | string | No | Phone number in E.164 format for voice integration; required only if voice integration is enabled |
| `lead_assistant` | string | Yes | Model ID of the lead assistant for this team |
| `external_webhook_url` | string | No | HTTPS endpoint to receive post-call data |
| `sub_assistants_attach` | array | No | List of sub-assistants with routing rules to attach to the team |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an action

**Slug:** `SYNTHFLOW_AI_DELETE_ACTION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action_id` | string | Yes | Unique identifier of the action to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete an assistant

**Slug:** `SYNTHFLOW_AI_DELETE_ASSISTANT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Unique identifier of the assistant to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a chat session

**Slug:** `SYNTHFLOW_AI_DELETE_CHAT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chat_id` | string | Yes | Unique identifier of the chat session to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a contact

**Slug:** `SYNTHFLOW_AI_DELETE_CONTACT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Unique identifier of the contact to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete knowledge base

**Slug:** `SYNTHFLOW_AI_DELETE_KNOWLEDGE_BASE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `knowledge_base_id` | string | Yes | Unique identifier of the knowledge base to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a knowledge base source

**Slug:** `SYNTHFLOW_AI_DELETE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_id` | string | Yes | Unique identifier of the source to be deleted from the knowledge base |
| `knowledge_base_id` | string | Yes | Unique identifier of the knowledge base containing the source |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a memory store

**Slug:** `SYNTHFLOW_AI_DELETE_MEMORY_STORE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `memory_store_id` | string | Yes | The unique identifier of the memory store to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a phone book

**Slug:** `SYNTHFLOW_AI_DELETE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `phone_book_id` | string | Yes | Unique identifier of the phone book to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a phone book entry

**Slug:** `SYNTHFLOW_AI_DELETE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entry_id` | string | Yes | ID of the specific phone book entry to delete |
| `phone_book_id` | string | Yes | ID of the phone book containing the entry to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a simulation case

**Slug:** `SYNTHFLOW_AI_DELETE_SIMULATION_CASE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `simulation_case_id` | string | Yes | Unique identifier of the simulation case to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a simulation scenario

**Slug:** `SYNTHFLOW_AI_DELETE_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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scenario_id` | string | Yes | Unique identifier of the simulation scenario to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a simulation suite

**Slug:** `SYNTHFLOW_AI_DELETE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `suite_id` | string | Yes | The unique identifier of the simulation suite to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a subaccount

**Slug:** `SYNTHFLOW_AI_DELETE_SUBACCOUNT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subaccount_id` | string | Yes | Unique identifier of the subaccount to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a team

**Slug:** `SYNTHFLOW_AI_DELETE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | ID of the team to delete, copyable from the UI |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach actions from assistant

**Slug:** `SYNTHFLOW_AI_DETACH_ACTION`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `actions` | array | No | Array of action IDs to detach (IDs found in Synthflow dashboard) |
| `model_id` | string | Yes | The ID of the agent you want to detach an action from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach knowledge base

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | ID of the agent from which the knowledge base needs to be detached |
| `knowledge_base_id` | string | Yes | Unique identifier of the knowledge base to detach |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach contact from memory store

**Slug:** `SYNTHFLOW_AI_DETACH_MEMORY_STORE_CONTACT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Unique identifier of the contact to detach from the memory store |
| `memory_store_id` | string | Yes | Unique identifier of the memory store from which to detach the contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detach memory store from agent

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assistant_id` | string | Yes | Unique identifier of the agent (assistant) from which to detach the memory store |
| `memory_store_id` | string | Yes | Unique identifier of the memory store to detach from the agent |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Execute simulation suite

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `suite_id` | string | Yes | UUID identifying the simulation suite to execute |
| `max_turns` | integer | No | Maximum number of turns per test case. Defaults to 20 if not specified. |
| `target_agent_id` | string | Yes | Agent ID to run the suite against. Must correspond to the suite's existing model_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export analytics data

**Slug:** `SYNTHFLOW_AI_EXPORT_ANALYTICS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | End date for analytics export in ISO 8601 date-time format (e.g., 2025-11-25T14:30:00Z). Defaults to current time if omitted. |
| `model_id` | string | No | Agent identifier to filter analytics for a specific assistant. Can be found on the agent dashboard page. |
| `from_date` | string | No | 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. |
| `type_of_call` | string ("inbound" | "outbound" | "widget") | No | Type of call for filtering analytics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get action metadata

**Slug:** `SYNTHFLOW_AI_GET_ACTION`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action_id` | string | Yes | Unique identifier of the action to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AI assistant details

**Slug:** `SYNTHFLOW_AI_GET_ASSISTANT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Unique identifier of the AI assistant to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get phone call details

**Slug:** `SYNTHFLOW_AI_GET_CALL`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `call_id` | string | Yes | Unique identifier of the call to retrieve transcript and metadata for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get contact details

**Slug:** `SYNTHFLOW_AI_GET_CONTACT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Unique identifier of the contact to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get knowledge base

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `knowledge_base_id` | string | Yes | Unique identifier of the knowledge base to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get memory store

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `memory_store_id` | string | Yes | Unique identifier of the memory store to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get memory store contact data

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | Unique identifier of the contact |
| `memory_store_id` | string | Yes | Unique identifier of the memory store |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get phone numbers

**Slug:** `SYNTHFLOW_AI_GET_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of phone numbers per page (defaults to 50) |
| `offset` | integer | No | Zero-based index of first phone number to return (defaults to 0) |
| `workspace` | string | Yes | Unique identifier of the workspace to list phone numbers for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get simulation details

**Slug:** `SYNTHFLOW_AI_GET_SIMULATION`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `simulation_id` | string | Yes | Unique identifier of the simulation to retrieve details for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Simulation Case

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `simulation_case_id` | string | Yes | Unique identifier (UUID) of the simulation case to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get simulation scenario

**Slug:** `SYNTHFLOW_AI_GET_SIMULATION_SCENARIO`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scenario_id` | string | Yes | Unique identifier of the simulation scenario to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get simulation suite by ID

**Slug:** `SYNTHFLOW_AI_GET_SIMULATION_SUITE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `suite_id` | string | Yes | The unique identifier of the simulation suite to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get subaccount details

**Slug:** `SYNTHFLOW_AI_GET_SUBACCOUNT`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subaccount_id` | string | Yes | Unique identifier of the subaccount to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get team details

**Slug:** `SYNTHFLOW_AI_GET_TEAM`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | Unique identifier of the team to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Initialize Action

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action_id` | string | Yes | The identifier for the custom action to initialize. |
| `variables` | array | No | Optional array of key-value pairs for action configuration variables. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List actions

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Actions displayed per page (defaults to 20 if omitted). |
| `offset` | integer | No | Index of the first action to be returned (defaults to 0). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List AI assistants

**Slug:** `SYNTHFLOW_AI_LIST_ASSISTANTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of assistants to return per page (defaults to 20 if omitted). |
| `offset` | string | No | Cursor for pagination; starting point for returning assistants (defaults to '0'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List call history

**Slug:** `SYNTHFLOW_AI_LIST_CALLS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Page size (number of call records to return), defaults to 20 |
| `offset` | integer | No | Index of the first call to be returned (for pagination), defaults to 0 |
| `to_date` | integer | No | End timestamp in milliseconds since epoch to filter calls until |
| `model_id` | string | Yes | The model/agent identifier whose calls should be returned |
| `from_date` | integer | No | Begin timestamp in milliseconds since epoch to filter calls from |
| `call_status` | string | No | Filter by status of the call (e.g., 'completed', 'no-answer', 'busy', 'failed') |
| `duration_max` | integer | No | Maximum call duration in seconds to filter by |
| `duration_min` | integer | No | Minimum call duration in seconds to filter by |
| `lead_phone_number` | string | No | Phone number in E.164 format to filter calls by (URL-encode leading '+' as %2B) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List chats

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit the number of chats to return (defaults to 10 if omitted) |
| `cursor` | string | No | Cursor to start from for pagination; use next_cursor from previous response |
| `agent_id` | string | No | Filter chats by agent ID to retrieve only chats associated with a specific agent |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List contacts

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Optional parameter to search for contacts by phone number |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List memory stores

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Filters results by the memory store's title |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Phone Books

**Slug:** `SYNTHFLOW_AI_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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Simulation Cases

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List simulation cases by agent

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agent_id` | string | Yes | Agent ID whose simulation cases to list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List simulations

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("in-progress" | "completed" | "failed") | No | Status of a simulation. |
| `end_date` | string | No | Maximum creation timestamp to filter until (ISO 8601 datetime format). |
| `page_size` | integer | No | Number of records per page (defaults to 10). |
| `start_date` | string | No | Minimum creation timestamp to filter from (ISO 8601 datetime format). |
| `page_number` | integer | No | Pagination page number (defaults to 1). |
| `target_agent_id` | string | No | Filter by target agent identifier. |
| `simulation_session_id` | string | No | Filter by simulation session ID (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List simulation scenarios

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Search term for filtering simulation scenario names. |
| `end_date` | string | No | Filter scenarios created on or before this date (ISO datetime format). |
| `page_size` | integer | No | Number of items per page (defaults to 10). |
| `start_date` | string | No | Filter scenarios created on or after this date (ISO datetime format). |
| `page_number` | integer | No | Page number for pagination (defaults to 1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List simulation sessions

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List simulation suites

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Search term for simulation suite names |
| `end_date` | string | No | Filter by created_at <= end_date (ISO datetime format) |
| `model_ids` | array | No | Filter by list of model IDs |
| `page_size` | integer | No | Number of items per page (default: 10) |
| `start_date` | string | No | Filter by created_at >= start_date (ISO datetime format) |
| `page_number` | integer | No | Page number (default: 1) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List subaccounts

**Slug:** `SYNTHFLOW_AI_LIST_SUBACCOUNTS`

Tool to list all subaccounts associated with the authenticated account. Use when you need to retrieve all subaccounts and their configurations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List teams

**Slug:** `SYNTHFLOW_AI_LIST_TEAMS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List voices

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of voices to return per page (defaults to 50) |
| `offset` | integer | No | Zero-based index of first voice to return (defaults to 0) |
| `workspace` | string | Yes | Unique identifier of the workspace to list voices for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List webhook logs

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Make a voice call

**Slug:** `SYNTHFLOW_AI_MAKE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Recipient's full name for personalization. |
| `phone` | string | Yes | Recipient's phone number in E.164 format (e.g., +15551234567). |
| `prompt` | string | No | Optional override of the default agent prompt for this call. |
| `greeting` | string | No | Optional override of the greeting the agent will use at call start. |
| `model_id` | string | Yes | Agent ID (from your dashboard). |
| `lead_email` | string | No | Optional customer email for appointment booking or follow-up. |
| `lead_timezone` | string | No | Optional customer IANA timezone (e.g., 'America/Los_Angeles'). |
| `custom_variables` | array | No | Optional list of key–value pairs to inject dynamically into the agent prompt. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Simulation

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_agent_id` | string | Yes | Identifier for the agent being tested. Must be a valid UUID. |
| `custom_variables` | object | No | Optional key-value pairs for dynamic test data injection during simulation execution. |
| `simulation_case_id` | string | Yes | Identifier for the simulation case to execute. Must be a valid UUID. |
| `simulation_session_id` | string | No | Optional identifier to group related simulations together. Must be a valid UUID if provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Action

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `SEND_SMS` | object | No | Send SMS action configuration. |
| `action_id` | string | Yes | Unique identifier of the action to update |
| `CUSTOM_EVAL` | object | No | Custom evaluation action configuration. |
| `CUSTOM_ACTION` | object | No | Custom action configuration for HTTP API calls. |
| `LIVE_TRANSFER` | object | No | Live transfer action configuration. |
| `REAL_TIME_BOOKING` | object | No | Real-time booking action configuration. |
| `INFORMATION_EXTRACTOR` | object | No | Information extractor action configuration. Can be YES_NO, SINGLE_CHOICE, or OPEN_QUESTION type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Assistant

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the assistant |
| `agent` | object | No | Partial assistant configuration object |
| `assistant_id` | string | Yes | Unique ID of the assistant to update |
| `consent_text` | string | No | Custom consent prompt text; required if consent_recording is true |
| `is_recording` | boolean | No | Whether to record calls; if omitted retains current setting |
| `max_duration` | object | No | Maximum call duration settings |
| `phone_number` | string | No | Phone number for outbound calls, e.g. +15551234567 |
| `caller_id_number` | string | No | Custom caller ID number to display, e.g. +12345678901 |
| `consent_recording` | boolean | No | If true, ask caller for consent before recording |
| `external_webhook_url` | string | No | Webhook URL to receive call events and transcripts |
| `is_transcript_disabled` | boolean | No | Disable transcription if true; defaults to false, transcripts will be generated unless explicitly disabled |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a contact

**Slug:** `SYNTHFLOW_AI_UPDATE_CONTACT`

Tool to update an existing contact in Synthflow AI. Use when you need to modify contact details like name, phone, email, or metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The contact's full name |
| `email` | string | No | The contact's email address |
| `contact_id` | string | Yes | Unique identifier of the contact to update |
| `phone_number` | string | No | The contact's phone number in E.164 format (e.g., +15551234567) |
| `contact_metadata` | object | No | Additional metadata for the contact as key-value pairs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update knowledge base

**Slug:** `SYNTHFLOW_AI_UPDATE_KNOWLEDGE_BASE`

Tool to update an existing knowledge base's name or usage conditions. Use after confirming the knowledge base exists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New designation for the knowledge base |
| `knowledge_base_id` | string | Yes | Unique identifier of the knowledge base to update |
| `rag_use_condition` | string | No | Specifies when this knowledge base should be utilized during conversations |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update memory store

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | New name for the memory store |
| `description` | string | No | New description for the memory store |
| `memory_store_id` | string | Yes | Unique identifier of the memory store to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Simulation Case

**Slug:** `SYNTHFLOW_AI_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the simulation case |
| `prompt` | string | No | New instructions or scenario for the simulation |
| `success_criteria` | array | No | New list of evaluation conditions that define successful simulation execution |
| `call_success_type` | string ("all" | "any") | No | Determines how success criteria are evaluated. |
| `simulation_case_id` | string | Yes | Unique identifier of the simulation case to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a simulation scenario

**Slug:** `SYNTHFLOW_AI_UPDATE_SIMULATION_SCENARIO`

Tool to update an existing simulation scenario. Use when you need to modify the name or description of a scenario template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New title for the simulation scenario template |
| `description` | string | No | Updated description of what the scenario template should verify |
| `scenario_id` | string | Yes | Unique identifier of the simulation scenario to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an existing simulation suite

**Slug:** `SYNTHFLOW_AI_UPDATE_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New designation for the simulation suite |
| `model_id` | string | No | New agent model identifier for the suite |
| `suite_id` | string | Yes | Unique identifier of the simulation suite to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update an existing team

**Slug:** `SYNTHFLOW_AI_UPDATE_TEAM`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New display name for the team assistant |
| `team_id` | string | Yes | Identifier of the team to update |
| `phone_number` | string | No | Phone number in E.164 format for voice integration |
| `external_webhook_url` | string | No | HTTPS endpoint to receive post-call data |
| `sub_assistants_attach` | array | No | List of sub-assistants to attach with routing logic |
| `sub_assistants_detach` | array | No | List of sub-assistants to detach by model ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |