Voices

List voices

Retrieves all available voices from the voice library.

string

required

voices

string

required

list

object

Any filter or pagination parameters supported by the voice library are forwarded as-is.

const response = await ApiService.invoke({
  resource: "voices",
  action: "list",
});

curl -X POST https://api.helpgenie.ai/v1/voices \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "voices",
    "action": "list"
  }'

Response

Returns voice library data forwarded directly from the upstream voice service.

List shared voices

Retrieves voices from the shared voice library.

string

required

voices

string

required

list-shared

object

Any filter or pagination parameters supported by the voice library are forwarded as-is.

const response = await ApiService.invoke({
  resource: "voices",
  action: "list-shared",
});

curl -X POST https://api.helpgenie.ai/v1/voices \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "voices",
    "action": "list-shared"
  }'

Response

Returns shared voice library data forwarded directly from the upstream voice service.

Search voices

Searches the voice library by one or more search terms.

string

required

voices

string

required

search

object

required

Show properties

string[]

required

Array of search terms. At least one term is required.

const response = await ApiService.invoke({
  resource: "voices",
  action: "search",
  data: {
    terms: ["Rachel", "American", "calm"],
  },
});

curl -X POST https://api.helpgenie.ai/v1/voices \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "voices",
    "action": "search",
    "data": {
      "terms": ["Rachel", "American", "calm"]
    }
  }'

Response

Returns matching voice data forwarded directly from the upstream voice service.

List favorite voices

Retrieves all voices that the authenticated user has added to their favorites.

string

required

voices

string

required

favorites

const response = await ApiService.invoke({
  resource: "voices",
  action: "favorites",
});

curl -X POST https://api.helpgenie.ai/v1/voices \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "voices",
    "action": "favorites"
  }'

Response

VoiceFavorite[]

Array of favorited voice records.

Show VoiceFavorite object

string

Unique favorite record identifier.

string

ID of the user who favorited the voice.

string

The external voice identifier.

object

Voice metadata stored at the time of favoriting.

string | null

ISO 8601 timestamp of when the voice was favorited.

number

Total number of favorited voices.

Add favorite voice

Adds a voice to the authenticated user’s favorites. If the voice is already favorited, returns the existing record without creating a duplicate.

string

required

voices

string

required

add-favorite

string

required

The voice ID to add to favorites.

object

Show properties

object

Voice metadata to store with the favorite record (name, language, accent, etc.).

const response = await ApiService.invoke({
  resource: "voices",
  action: "add-favorite",
  id: "voice-id",
  data: {
    voice_data: {
      name: "Rachel",
      language: "en",
      accent: "American",
    },
  },
});

Response (status 201)

VoiceFavorite

The newly created favorite record. See the VoiceFavorite object for field details.

If the voice is already favorited, the response returns:

boolean

true when the voice was already in favorites.

string

The voice ID that was already favorited.

Remove favorite voice

Removes a voice from the authenticated user’s favorites.

string

required

voices

string

required

remove-favorite

string

required

The voice ID to remove from favorites.

const response = await ApiService.invoke({
  resource: "voices",
  action: "remove-favorite",
  id: "voice-id",
});

Response

boolean

true if the voice was successfully removed from favorites.

string

The voice ID that was removed.

Track voice usage

Records that a voice was used. This is a fire-and-forget operation; errors are logged server-side but do not cause the request to fail.

string

required

voices

string

required

track-usage

string

required

The voice ID to track usage for.

object

Show properties

string

The context in which the voice was used. Valid values:

Value	Description
`preview`	User previewed / listened to the voice sample
`select`	User selected the voice for an existing genie
`agent_creation`	Voice was chosen during new genie creation

string

The genie ID, if the usage is related to genie creation or configuration.

Authentication is optional. Anonymous usage is tracked when no token is provided.

Track-usage is a fire-and-forget operation. The endpoint always returns { success: true } even if the underlying database write fails. Errors are logged server-side but are never surfaced to the caller, so it is safe to call without awaiting or error-handling.

const response = await ApiService.invoke({
  resource: "voices",
  action: "track-usage",
  id: "voice-id",
  data: {
    context: "agent_creation",
    agentId: "agent-uuid",
  },
});

Response

boolean

Always returns true, regardless of whether the tracking write succeeded internally.

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

List voices

Response

List shared voices

Response

Search voices

Response

List favorite voices

Response

Add favorite voice

Response (status 201)

Remove favorite voice

Response

Track voice usage

Response

​List voices

​Response

​List shared voices

​Response

​Search voices

​Response

​List favorite voices

​Response

​Add favorite voice

​Response (status 201)

​Remove favorite voice

​Response

​Track voice usage

​Response

List voices

Response

List shared voices

Response

Search voices

Response

List favorite voices

Response

Add favorite voice

Response (status 201)

Remove favorite voice

Response

Track voice usage

Response