Update Voice

Endpoint used to update the voice settings of the AI agent.

Request Example

curl --request PUT \
  --url https://chat.api.toolzz.com.br/api/v1/bot/voice/{botId} \
  --header 'Authorization: Bearer TOKEN_HERE' \
  --header 'Content-Type: application/json' \
  --data '
    {
        "visualIconId": "uuid",
        "visualType": "<string>",
        "transcriptionCredentialId": "uuid",
        "voiceCredentialId": "uuid",
        "language": "<string>",
        "firstMessage": "<string>",
        "fallbackPhrase": "<string>",
        "voiceId": "<string>",
        "voiceImage": "<url>",
        "voiceName": "<string>",
        "voiceDescription": "<string>",
        "insertedLabsId": "<string>",
        "model": "<string>",
        "voiceModel": "<string>",
        "deepgramModel": "<string>",
        "primaryColor": "<string>",
        "buttonColor": "<string>",
        "webPrimaryColor": "<string>",
        "webButtonColor": "<string>",
        "theme": "<string>",
        "textTitle": "<string>",
        "textDescription": "<string>",
        "waitTime": 123,
        "callTime": 123,
        "voicePrompt": "<string>",
        "webhookUrl": "<url>"
    }
'

Response Example

{
  "id": "uuid",
  "botId": "uuid",
  "visualIconId": "uuid",
  "visualType": "<string>",
  "language": "<string>",
  "voiceModel": "<string>",
  "deepgramModel": "<string>",
  "primaryColor": "<string>",
  "theme": "<string>",
  "textTitle": "<string>",
  "waitTime": 123,
  "callTime": 123,
  "bot": {
    "id": "uuid",
    "name": "<string>",
    "prompt": "<string>",
    "metaprompt": "<string>"
  },
  "visualIcon": {
    "id": "uuid",
    "url": "<url>",
    "extension": "<string>"
  },
  "voiceCredential": {
    "id": "uuid",
    "name": "<string>",
    "integration": {
      "name": "<string>",
      "slug": "<string>",
      "file": {
        "url": "<url>"
      }
    }
  },
  "voicePrompt": "<string>"
}

---

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

URL Parameters (Path)

Parameter	Type	Description	Required
botId	UUID	Unique identifier of the agent.	Yes

Body Parameters

Parameter	Type	Description	Required
visualIconId	UUID	ID of the visual icon file for the voice interface.	No
visualType	String	Visual style of the component (e.g., “compact”, “button”, “full”).	Yes
transcriptionCredentialId	UUID	Credential ID for the transcription service (STT).	No
voiceCredentialId	UUID	Credential ID for the voice synthesis service (TTS).	Yes
language	String	Default language code (e.g., “ptbr”, “enus”).	Yes
voiceModel	String	AI model for audio processing (e.g., “gemini-2.0-flash”).	Yes
deepgramModel	String	Specific model for the Deepgram provider, if applicable.	No
primaryColor	String	Primary color of the voice interface (Hexadecimal).	Yes
buttonColor	String	Voice action button color (Hexadecimal).	Yes
theme	String	Interface theme (e.g., “light”, “dark”).	Yes
textTitle	String	Title displayed on the voice component.	Yes
waitTime	Number	Wait time (in seconds) before starting processing.	Yes
callTime	Number	Maximum duration of the call or interaction (in minutes).	Yes
voicePrompt	String	Specific behavior instructions for the voice interaction.	No
webhookUrl	URL	URL for sending events and logs of the voice interaction.	No

Response description

Key	Type	Description
id	UUID	Unique identifier of the voice configuration.
botId	UUID	Identifier of the Agent to which this configuration belongs.
visualIconId	UUID	ID of the image file used as the voice assistant icon.
visualType	String	Visual style of the component (e.g., compact, full).
language	String	Configured language for the interaction (e.g., ptbr).
voiceModel	String	Voice processing model (e.g., gemini-2.0-flash).
deepgramModel	String	Specific transcription model for Deepgram integration.
primaryColor	String	Primary color of the voice interface (Hexadecimal).
theme	String	Visual theme of the interface (light or dark).
textTitle	String	Title displayed in the header of the voice component.
waitTime	Number	Configured wait time before the response.
callTime	Number	Call time limit in minutes.
bot	Object	Object containing basic data and the metaprompt of the linked Agent.
bot.name	String	Agent’s name.
bot.creativePrecision	Number	IA accuracy/creativity level.
visualIcon	Object	Icon file metadata (URL, size, extension).
voiceCredential	Object	Details of the credential used for the voice service.
voiceCredential.name	String	Name assigned to the credential (e.g., tzz-voice).
voiceCredential.integration	Object	Service provider information (e.g., ElevenLabs).
voiceCredential.integration.slug	String	Textual identifier of the provider.
voicePrompt	String	Specific behavior instructions for the voice.

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.

To access your access token, follow these steps:

1. Log in to the ToolzzAI platform
2. Click on “Settings”
3. Click on “Access Token”
4. Copy the access token