Synthflow icon

Synthflow

Interact with Synthflow AI API
Join our community

Actions8

Overview

This node interacts with the Synthflow AI API to update an existing Synthflow agent's configuration. It allows users to modify various agent properties such as the agent's name, type, phone number, webhook URLs, recording settings, maximum call duration, and raw JSON configuration. This operation is useful for maintaining and customizing AI voice agents to better fit evolving business needs or to correct agent settings without recreating the agent from scratch.

Use Case Examples

  1. Updating the name and type of an existing Synthflow AI agent to reflect a new campaign.
  2. Modifying webhook URLs and enabling call recording for an agent to integrate with external systems and comply with recording policies.
  3. Replacing the entire agent configuration using raw JSON to apply complex updates in one request.

Properties

Name Meaning
Agent Model ID The unique identifier of the Synthflow agent to update (model_id). This is required to specify which agent to modify.
Update Fields A collection of fields to update on the agent. This includes: Agent JSON (raw JSON to replace the agent configuration), Agent Name (new name for the agent), and Agent Type (type of the agent: outbound, inbound, or widget).

Output

JSON

  • id - The unique identifier of the updated agent.
  • type - The type of the updated agent (outbound, inbound, widget).
  • name - The updated name of the agent.
  • description - Description of the agent if provided.
  • phone_number - Phone number associated with the agent if provided.
  • external_webhook_url - Webhook URL for post-call data if provided.
  • inbound_call_webhook_url - Webhook URL for inbound call events if provided.
  • is_recording - Boolean indicating if call recording is enabled.
  • max_duration - Object containing max call duration settings, including duration in seconds and whether the limit is enabled.
  • agent - The agent configuration object, which may include consent message, language model, voice ID, and other agent-specific settings.

Dependencies

  • Synthflow AI API

Troubleshooting

  • Invalid JSON in the 'Agent JSON' field will cause an error. Ensure the JSON is well-formed and represents an object.
  • If no update fields are provided, the node throws an error indicating no fields to update. Make sure to specify at least one field to update.
  • API authentication errors may occur if the Synthflow API credentials are missing or invalid. Verify the API key credential is correctly configured.

Links

Discussion