Preselected voices

Preselected voices are the platform-level voice options shown to users during genie setup. Regular users can browse all active voices; creating, updating, and deleting entries is restricted to admins.

Actions

`all`

Returns all preselected voices, ordered by sort_order. Regular users see only active voices (is_active: true). Admins see all voices regardless of active status. Response

{
  "voices": [
    {
      "id": "voice-uuid",
      "voice_id": "external-voice-id",
      "label": "Rachel",
      "description": "Warm, professional female voice",
      "gender": "female",
      "sort_order": 0,
      "is_active": true,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "count": 12
}

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

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

`create`

Adds a new preselected voice to the platform library. Admin only.

string

required

Platform voice identifier to add to the curated list.

string

required

Display name shown to users.

string

Optional description of the voice character or style.

string

required

Must be "male" or "female".

number

default:"0"

Display order position.

boolean

default:"true"

Whether the voice is visible to regular users.

Response — 201

{
  "voice": {
    "id": "voice-uuid",
    "voice_id": "external-voice-id",
    "label": "Rachel",
    "description": "Warm, professional female voice",
    "gender": "female",
    "sort_order": 0,
    "is_active": true,
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": null
  }
}

const response = await ApiService.invoke({
  resource: "preselected-voices",
  action: "create",
  data: {
    voice_id: "external-voice-id",
    label: "Rachel",
    description: "Warm, professional female voice",
    gender: "female",
    sort_order: 1,
    is_active: true,
  },
});

curl -X POST https://api.helpgenie.ai/v1/preselected-voices \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "preselected-voices",
    "action": "create",
    "data": {
      "voice_id": "external-voice-id",
      "label": "Rachel",
      "description": "Warm, professional female voice",
      "gender": "female",
      "sort_order": 1,
      "is_active": true
    }
  }'

`update`

Updates a preselected voice entry. Admin only. Only the fields you supply are changed. Pass the voice UUID as the request id. All data fields below are optional.

string

Updated display name.

string

Updated description.

string

Updated gender. Must be "male" or "female".

number

Updated display order position.

boolean

Toggle visibility for regular users.

Response

{
  "voice": { /* updated preselected voice object */ }
}

const response = await ApiService.invoke({
  resource: "preselected-voices",
  action: "update",
  id: "voice-uuid",
  data: {
    label: "Rachel (Updated)",
    is_active: false,
  },
});

curl -X POST https://api.helpgenie.ai/v1/preselected-voices \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "preselected-voices",
    "action": "update",
    "id": "voice-uuid",
    "data": {
      "label": "Rachel (Updated)",
      "is_active": false
    }
  }'

`delete`

Permanently removes a preselected voice from the platform library. Admin only. Irreversible. Parameters

Field	Type	Required	Description
`id`	string	Yes	Preselected voice UUID (passed as request ID)

Response

{ "success": true, "message": "Preselected voice deleted successfully" }

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

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

Voice object fields

Field	Type	Description
`id`	string	Unique preselected voice identifier
`voice_id`	string	External voice identifier
`label`	string	Display name shown to users
`description`	string \| null	Optional description
`gender`	`"male"` \| `"female"`	Voice gender
`sort_order`	number	Display order position
`is_active`	boolean	Whether the voice is visible to regular users
`created_at`	string \| null	ISO 8601 creation timestamp
`updated_at`	string \| null	ISO 8601 last-updated timestamp

Error codes

Code	Meaning
`VALIDATION_ERROR`	Missing or invalid required parameter
`NOT_FOUND`	Preselected voice not found
`FORBIDDEN`	Admin access required
`INTERNAL_ERROR`	Unexpected server error

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

Actions

`all`

`create`

`update`

`delete`

Voice object fields

Error codes

​Actions

​all

​create

​update

​delete

​Voice object fields

​Error codes

Actions

`all`

`create`

`update`

`delete`

Voice object fields

Error codes