FruxonDocs
ApiVoice

Lists the voices an agent can speak with.

`source=fruxon` lists the Fruxon voice's 30 voices (Google Chirp 3 HD), the same names in Hebrew and English, each with the gender the provider labels it with. A label describes the voice, not how the agent refers to itself. `source=integration` with `integrationConfigId` lists the voices of the workspace's own ElevenLabs account, read with its key: its premade, cloned and library voices, with their category and gender and accent labels. One ElevenLabs model speaks both languages with any of them. The list is kept for five minutes per account, and doubles as a connection check: a key ElevenLabs refuses answers 400 `voice_config_unavailable`. Where ElevenLabs voices are not switched on, it answers 400 `voice_option_unsupported`. Answers 404 `voice_disabled` where voice is off.

GET
/v1/tenants/{tenant}/voices
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

tenant*string

The tenant identifier

Query Parameters

source?string

fruxon (the default) or integration.

language?string

The call language, he or en (the default).

integrationConfigId?string

With integration: the workspace's elevenlabs config.

Formatuuid
PageSize?integer

The maximum number of items to return per page

Formatint32
PageToken.Skip?integer
Formatint32
PageToken.Cursor?string

Opaque pagination token returned by an external service. Pass it back unchanged rather than interpreting it as an offset.

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/voices"
{
  "items": [
    {
      "voiceId": "string",
      "displayName": "string",
      "gender": "string",
      "accent": "string",
      "category": "string"
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty