Synthflow icon

Synthflow

Interact with Synthflow AI API

Get Agent

AI-generated

Overview

This node interacts with the Synthflow AI API to manage AI voice agents and calls. Specifically, the 'Get Agent' operation retrieves detailed information about a single Synthflow AI agent using its model ID. This is useful for scenarios where you need to fetch the configuration or status of a specific AI agent, such as verifying agent details before making calls or updating configurations.

Use Case Examples

  1. Retrieve details of a Synthflow AI agent by providing its unique model ID to monitor or audit the agent's settings.
  2. Use the node to fetch agent information as part of a workflow that manages multiple AI agents dynamically.

Properties

Name Meaning
Agent Model ID The unique identifier (model_id) of the Synthflow AI agent to retrieve information for.

Output

JSON

  • id - The unique identifier of the Synthflow AI agent.
  • type - The type of the agent (e.g., outbound, inbound, widget).
  • name - The name of the agent.
  • description - Description of the agent, if provided.
  • phone_number - Phone number associated with the agent, if any.
  • external_webhook_url - Webhook URL for post-call data.
  • inbound_call_webhook_url - Webhook URL for inbound call events.
  • is_recording - Boolean indicating if call recording is enabled.
  • max_duration - Object containing max call duration settings.
  • agent - Object containing agent-specific configuration such as prompt, greeting message, language model, language, voice ID, consent message, and consent settings.

Dependencies

  • Synthflow AI API

Troubleshooting

  • Ensure the 'Agent Model ID' is correctly provided and corresponds to an existing agent in the Synthflow workspace; otherwise, the API will return an error.
  • Check that the API credentials for Synthflow are correctly configured and have the necessary permissions to access agent data.
  • If the node throws an error about invalid JSON, verify that any JSON input fields (not applicable for 'Get Agent' but relevant for other operations) are correctly formatted.

Links

Discussion