# Synthflow integration

> Build and run AI voice and chat agents: manage agents, place calls and batch campaigns, chats, actions, knowledge bases, phone numbers, contacts, memory stores, simulations, and analytics.

- Authentication: apiKey

## Tools (110)

- **Add a knowledge base source**: Add a knowledge base source
- **Attach a contact to a memory store**: Attach a contact to a memory store
- **Attach a knowledge base**: Attach a knowledge base
- **Attach a memory store to an agent**: Attach a memory store to an agent
- **Attach an action**: Attach an action
- **Attach phone numbers to an outbound agent**: Attach multiple outbound phone numbers to an agent by phone numbers or by slugs.
- **Cancel a batch call**: Permanently stops the batch. Recipients that have not been dialed are marked canceled and will never be called. Calls already in progress are not hung up. A canceled batch cannot be resumed and cannot take new recipients.
- **Create a batch call**: Creates a batch of outbound calls that are dialed over time as your account's concurrency allows. Provide `batch_call_id` to append more recipients to an existing batch instead of creating a new one.
- **Create a chat**: Create a new chat session with an agent.
- **Create a contact**: Create a contact
- **Create a knowledge base**: Creates a new knowledge base and returns its ID.
- **Create a memory store**: Create a memory store
- **Create an action**: Creates an action. There is no `input_variables` parameter on this endpoint.
- **Create an agent**: Create an agent
- **Create a phone book**: Create a phone book
- **Create a phone book entry**: Create a phone book entry
- **Create a simulation case**: Create a new simulation case for a workspace.
- **Create a simulation scenario**: Create a new simulation scenario. Scenarios are templates used when generating test cases to ensure coverage of specific situations.
- **Create a simulation suite**: Create a new simulation suite attached to a specific agent. The suite can only be executed on the agent specified by model_id.
- **Create a subaccount**: Create a subaccount
- **Delete a chat**: Delete a chat session.
- **Delete a contact**: Delete a contact
- **Delete a knowledge base**: Delete a knowledge base
- **Delete a knowledge base source**: Delete a knowledge base source
- **Delete a memory store**: Delete a memory store
- **Delete an action**: Delete an action
- **Delete an agent**: Use this endpoint to delete an agent.
- **Delete a phone book**: Delete a phone book
- **Delete a phone book entry**: Delete a phone book entry
- **Delete a phone number**: Deletes a phone number from your workspace. This will detach the phone number from any agents it is linked to. For phone numbers purchased through Synthflow, this also cancels the monthly subscription.
- **Delete a simulation case**: Delete a simulation case by ID.
- **Delete a simulation scenario**: Delete a simulation scenario by ID.
- **Delete a simulation suite**: Delete a simulation suite by ID.
- **Delete a subaccount**: Deletes a subaccount by ID.
- **Delete MCP configuration**: Removes the MCP configuration and associated secrets from Vault.
- **Detach a contact from a memory store**: Detach a contact from a memory store
- **Detach a knowledge base**: Detach a knowledge base
- **Detach a memory store from an agent**: Detach a memory store from an agent
- **Detach an action**: Detach an action
- **Detach phone number from an outbound agent**: Remove one attached outbound phone number from an agent.
- **Discover MCP tools**: Discovers available MCP tools across all servers configured for the workspace.
- **Execute a simulation suite**: Execute all test cases in a suite. The suite runs on the agent it was created for (determined by the suite's model_id).
- **Export analytics data**: Export analytics programmatically for blending with your BI dashboards or internal reporting tools. ### Troubleshooting * If you are not seeing data for a specific agent, double-check the model_id you are using.
- **Generate test cases**: Generate test cases for an agent. Supports both custom prompt and flow designer agents. You can optionally specify scenarios to ensure the generated tests cover specific situations.
- **Get a batch call**: Returns the batch's status and its recipient counters.
- **Get a call**: Retrieve the transcript and other metadata for a phone call.
- **Get a chat**: Retrieve details of a specific chat session.
- **Get a contact**: Get a contact
- **Get a knowledge base**: Retrieves the knowledge base's name and use condition.
- **Get a knowledge base source**: Returns one source of a knowledge base. For a `text` source, `content` holds the full text and `url` is a download link for the same text that expires after 7 days. The list endpoint returns only a 200-character preview.
- **Get a memory store**: Get a memory store
- **Get an action**: Retrieves metadata about an action.
- **Get an agent**: Get an agent
- **Get a phone number**: Retrieves detailed information about a specific phone number.
- **Get a simulation**: Retrieve a simulation by ID.
- **Get a simulation case**: Retrieve a simulation case by ID.
- **Get a simulation scenario**: Retrieve a simulation scenario by ID.
- **Get a simulation session**: Retrieve simulation session details by ID.
- **Get a simulation suite**: Retrieve a simulation suite by ID.
- **Get a subaccount**: Retrieves detailed metadata about a specific subaccount by ID.
- **Get data for a specific memory store and contact**: Get data for a specific memory store and contact
- **Get MCP configuration**: Retrieves the MCP server configuration for a specific workspace.
- **Get the WebSocket media base URL**: Returns the region-correct WebSocket base URL (no session id) for the connect-then-bind flow. Connect to this URL first, read the `server_info` message, then start the call with `wsMediaServerName` set to the `server-name` you received.
- **Get voices**: Lists all the voices assigned to a workspace.
- **Get Webhook Log Detail**: Retrieve detailed information for a specific webhook log
- **Import phone number**: Imports a custom phone number into your workspace. This is useful for direct SIP dialing scenarios where your telephony provider does not offer elastic SIP trunking.
- **Initialize a custom action**: Initialize a custom action
- **Invoke an MCP tool**: Invokes a namespaced MCP tool on the appropriate server. This is a synchronous call that may take 8–15 seconds.
- **List actions**: List actions
- **List agents**: Lists all agents you have in your account.
- **List batch call recipients**: Lists every recipient in the batch with its outcome, in the order they were added.
- **List batch calls**: Lists the workspace's batch calls, most recently created first.
- **List calls**: Returns a paginated list of calls for the specified model. You can optionally filter by time window, status, duration range, or phone number.
- **List chats**: Retrieve a list of chats, optionally filtered by agent ID.
- **List contacts**: List contacts
- **List knowledge bases**: Retrieves knowledge bases for the workspace.
- **List knowledge base sources**: Returns a paginated list of sources for the specified knowledge base.
- **List memory stores**: List memory stores
- **List phone book entries**: List the entries of a phone book.
- **List phone books**: List all phone books in your workspace.
- **List phone numbers**: Lists all phone numbers assigned to a workspace.
- **List simulation cases**: List simulation cases with pagination and optional filtering.
- **List simulation cases by agent**: List all simulation cases created for a specific agent.
- **List simulations**: List simulations with pagination and optional filters.
- **List simulation scenarios**: List simulation scenarios with pagination and optional filtering.
- **List simulation sessions**: List simulation sessions with pagination and optional filters.
- **List simulation suites**: List simulation suites with pagination and optional filtering.
- **List subaccounts**: List subaccounts
- **List Webhook Logs**: Retrieve a paginated list of webhook logs with filtering and search capability
- **Make a call**: Initiates a real-time phone call through the AI agent.
- **Pause a batch call**: Suspends dialing. Recipients that have not been dialed stay queued, so resuming continues where the batch left off. Calls already in progress are not affected. A batch can be paused while it is `scheduled` or `in_progress`.
- **Resume a batch call**: Resumes a paused batch. Dialing restarts within a few seconds with the recipients that were still queued when the batch was paused, and the batch returns to `scheduled` rather than `in_progress`. Only paused batches can be resumed.
- **Send a message in a chat**: Send a message to an agent within an existing chat session.
- **Set MCP configuration**: Adds or updates MCP server entries for the workspace. Existing servers not included in the payload are preserved unchanged.
- **Start an outbound chat conversation**: Create a new outbound WhatsApp or SMS conversation for a chat agent.
- **Start a simulation**: Start a new simulation using a simulation case.
- **Start a WebSocket media call**: Starts an outbound test call and returns a short-lived WebSocket URL for streaming call audio.
- **Update a contact**: Update a contact
- **Update a knowledge base**: Update a knowledge base
- **Update a knowledge base source**: Update an existing knowledge base source by source ID. The updatable fields depend on the existing source type: - `link` / `file`: `url` - `text`: `content` You can always update `name`.
- **Update a memory store**: Update a memory store
- **Update an action**: For live transfer, custom, information extractor and post-call email actions, fields you omit keep their stored values.
- **Update an agent**: Use this endpoint to update an agent's name, phone number, or other parameters. Only the provided parameters will be updated, and others won't be removed or changed.
- **Update a phone book entry**: Replace the phone number and transfer condition of a phone book entry. Both fields are required. A phone number must be unique within its phone book.
- **Update a phone number**: Updates the configuration of a phone number.
- **Update a simulation case**: Update an existing simulation case.
- **Update a simulation scenario**: Update an existing simulation scenario.
- **Update a simulation suite**: Update an existing simulation suite.
- **Update a subaccount**: Update a subaccount
- **Update MCP configuration**: Updates an existing MCP configuration for a specific workspace. Returns 404 if no configuration exists (use POST to create one).

Connect Synthflow in General Input: https://www.generalinput.com/apps/synthflow