RetellAI icon

RetellAI

Interact with RetellAI API

Actions21

Overview

The "Voice - Get Many" operation in this node allows users to retrieve multiple voice options from the RetellAI API. It is useful for scenarios where you want to list or filter available voices for text-to-speech or other voice-related functionalities. For example, you might want to fetch all female voices with a British accent from specific providers to offer users a selection of voices in an application.

Practical examples include:

  • Populating a dropdown menu with available voices filtered by gender, accent, or provider.
  • Fetching voice details to preview or select voices programmatically before generating speech.
  • Retrieving voice models and preview audio URLs to enhance user experience in voice-enabled applications.

Properties

Name Meaning
Return Provider Details Whether to return detailed information about the voice provider along with the voices.
Options Collection of filters to narrow down the voices returned:
- Filter By Provider Select one or more voice providers to filter voices (Eleven Labs, OpenAI, Deepgram).
- Filter By Gender Filter voices by gender: Male or Female.
- Filter By Accent Filter voices by accent using a string (e.g., American, British).
Additional Fields Additional optional parameters:
- Include Preview Audio Whether to include a URL for preview audio of the voice in the response.
- Include Voice Models Whether to include available voice models in the response (only applicable for certain providers).
- Language Filter voices by language, options include English (UK), English (US), French, German, Italian, Japanese, Korean, Portuguese, Spanish.

Output

The output JSON array contains objects representing voices matching the specified filters. Each voice object may include:

  • Basic voice properties such as name, gender, accent, language, and provider.
  • Optionally, detailed provider information if "Return Provider Details" is enabled.
  • Optionally, preview audio URLs if requested.
  • Optionally, available voice models for certain providers.

If binary data is involved (not explicitly shown here), it would typically represent audio previews or samples.

Dependencies

  • Requires an active connection to the RetellAI API.
  • Requires an API authentication token configured in the node credentials.
  • The node depends on the RetellAI service being accessible at https://api.retellai.com.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Filtering by unsupported providers or invalid filter values may result in empty responses.
    • Requesting voice models for providers that do not support them will have no effect.

  • Error Messages:

    • Authentication failures: Check that the API key credential is correctly set up.
    • Network errors: Verify internet connectivity and RetellAI API availability.
    • Validation errors: Ensure filter values conform to allowed options (e.g., valid gender, language codes).

Links and References

Discussion