RetellAI icon

RetellAI

Interact with RetellAI API

Actions21

Overview

The node integrates with the RetellAI API to manage various resources, including Agents. Specifically, for the Agent - Update operation, it updates an existing agent's details such as its voice, name, and additional configuration settings. This is useful in scenarios where you want to modify an AI agent’s characteristics dynamically, for example, changing the voice or tuning parameters like speech speed without recreating the agent.

Practical examples include:

  • Updating an agent’s voice to a different available voice ID after testing.
  • Changing the agent’s display name to reflect new branding.
  • Adjusting advanced configuration options (like voice speed) via JSON to optimize interaction quality.

Properties

Name Meaning
Voice ID Unique identifier of the voice used by the agent. Users select from available voices loaded dynamically.
Agent Name The display name of the agent.
Additional Configuration JSON object containing extra agent settings using snake_case keys (e.g., voice_speed). Refer to the API documentation for all configurable fields.
Agent ID The unique identifier of the agent to update.

Output

The node outputs a JSON array where each item corresponds to the result of updating an agent. Each JSON object contains the updated agent data returned by the RetellAI API. The exact structure depends on the API response but typically includes fields like agent ID, name, voice ID, and configuration details.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the RetellAI API.
  • Needs an API authentication token configured in n8n credentials (referred generically as "an API key credential").
  • The node uses the base URL https://api.retellai.com and sends requests with Content-Type: application/json.
  • The list of available voices for the "Voice ID" property is dynamically loaded from the API.

Troubleshooting

  • Invalid Agent ID: If the provided Agent ID does not exist or is malformed, the API will return an error. Verify the Agent ID before updating.
  • Invalid Voice ID: Selecting a voice ID that is not available or supported will cause the update to fail. Use the dynamic voice loader to pick valid voices.
  • Malformed JSON in Additional Configuration: The additionalConfig field must be valid JSON with correct snake_case keys. Invalid JSON or unsupported keys will cause errors.
  • Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Network Issues: Connectivity problems to api.retellai.com will prevent the update operation.

To resolve errors, check the error message returned by the node, verify input values, and consult the RetellAI API documentation linked in the property description.

Links and References

Discussion