Skip to main content

List Available Assistant Voices

GET 
/v1/users/{userId}/assistant-voices

Retrieves the list of AI assistant voices available for the user's region.

Voice Selection​

Available voices are determined by:

  • Country Code: Voices localized for the user's phone number region
  • Language Support: Voices supporting the user's preferred language
  • Carrier Configuration: Voices enabled by the carrier's service agreement

Response Data​

Each voice entry includes:

  • Voice ID: Unique identifier for setting the user's preferred voice
  • Display Name: Human-readable voice name (e.g., "Ember", "Lumen")
  • Sample URL: Audio sample for preview (if available)

Integration​

Use the returned voice IDs when updating user preferences via PUT /preferences with the assistantVoiceId field.

Path Parameters​

    userId stringrequired

    The unique identifier of the user

Header Parameters​

    x-hiya-product-version string

    Product version. The standard "major.minor.patch" format is highly encouraged without any leading characters; "2.1.3" or "3.0.0" for example.

    x-hiya-account-user-id stringrequired

    The identifier of a logged-in user. Same identifier that is used for /users/{user_id}

Responses​

A list of available assistant voices for the user's country

Response Body

application/json