RetellAI icon

RetellAI

Interact with RetellAI API

Actions21

Overview

The node interacts with the RetellAI API to retrieve detailed information about a specific voice resource. The "Get Voice" operation allows users to fetch data about a particular voice by its unique ID, optionally including additional details such as provider information, preview audio URLs, available voice models, and filtering by language.

This node is beneficial in scenarios where you want to dynamically obtain voice characteristics or metadata for use in text-to-speech applications, voice selection interfaces, or voice customization workflows. For example, you might use it to display voice options to end-users or to programmatically select a voice based on language or provider capabilities before generating speech.

Properties

Name Meaning
Voice ID Unique identifier of the voice to retrieve.
Return Provider Details Whether to include detailed information about the voice's provider in the response (true/false).
Additional Fields Collection of optional fields:
- Include Preview Audio Whether to include a URL for preview audio of the voice in the response (true/false).
- Include Voice Models Whether to include available voice models for the voice (only applicable for certain providers) (true/false).
- Language Filter voices by language. Options: English (UK), English (US), French, German, Italian, Japanese, Korean, Portuguese, Spanish. Default is English (UK).

Output

The output JSON contains detailed information about the requested voice. This includes:

  • Basic voice metadata such as name, ID, language, and other descriptive attributes.
  • Optionally, provider details if requested.
  • Optionally, a preview audio URL to listen to a sample of the voice.
  • Optionally, a list of available voice models associated with the voice.
  • The structure is an array of JSON objects, each representing a voice with the above details.

If preview audio is included, it will be provided as a URL within the JSON; no binary data output is indicated.

Dependencies

  • Requires an active connection to the RetellAI API.
  • Requires an API authentication token credential configured in n8n to authorize requests.
  • The base URL for API requests is https://api.retellai.com.
  • No other external dependencies are indicated.

Troubleshooting

  • Common Issues:

    • Invalid or missing Voice ID: The node requires a valid voice identifier; ensure this is correctly set.
    • Authentication errors: Verify that the API key credential is correctly configured and has necessary permissions.
    • Network issues: Ensure connectivity to the RetellAI API endpoint.
    • Unsupported language or provider options may result in empty or partial responses.

  • Error Messages:

    • Errors returned from the API will be surfaced in the node output if "Continue On Fail" is enabled.
    • Typical error messages include invalid parameters or unauthorized access.
    • To resolve, check input parameters, credentials, and network status.

Links and References

Discussion