Update Experience

curl -X PATCH https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/experience \
  -H "X-API-Key: vaani_<your_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "conversational_experience": {
      "eagerness_to_speak": "fast",
      "bg_noise": { "enabled": true, "volume": 0.2, "sound": "office" }
    },
    "settings": {
      "call_settings": {
        "max_call_duration": 30,
        "max_duration_enabled": true,
        "enable_voicemail_detection": true,
        "action": "leave_message",
        "end_call_message": "Sorry we missed you, please call back during business hours."
      }
    }
  }'

const response = await fetch(
  "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/experience",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "vaani_<your_key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      conversational_experience: {
        eagerness_to_speak: "fast",
        bg_noise: { enabled: true, volume: 0.2 },
      },
      settings: {
        call_settings: { max_call_duration: 30 },
      },
    }),
  }
);
const data = await response.json();
console.log(data);

import requests

requests.patch(
    "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/experience",
    headers={"X-API-Key": "vaani_<your_key>", "Content-Type": "application/json"},
    json={
        "conversational_experience": {
            "eagerness_to_speak": "balanced",
            "bg_noise": {"enabled": False},
        },
        "settings": {
            "idle_conversation_settings": {
                "idle_call_hangup_timeout": 20,
                "idle_call_hangup_message": "It seems you've stepped away. Goodbye!",
            }
        },
    },
)

{
  "success": true,
  "message": "Experience section updated successfully"
}

PATCH

api

agent

{agent_id}

experience

curl -X PATCH https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/experience \
  -H "X-API-Key: vaani_<your_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "conversational_experience": {
      "eagerness_to_speak": "fast",
      "bg_noise": { "enabled": true, "volume": 0.2, "sound": "office" }
    },
    "settings": {
      "call_settings": {
        "max_call_duration": 30,
        "max_duration_enabled": true,
        "enable_voicemail_detection": true,
        "action": "leave_message",
        "end_call_message": "Sorry we missed you, please call back during business hours."
      }
    }
  }'

const response = await fetch(
  "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/experience",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "vaani_<your_key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      conversational_experience: {
        eagerness_to_speak: "fast",
        bg_noise: { enabled: true, volume: 0.2 },
      },
      settings: {
        call_settings: { max_call_duration: 30 },
      },
    }),
  }
);
const data = await response.json();
console.log(data);

import requests

requests.patch(
    "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/experience",
    headers={"X-API-Key": "vaani_<your_key>", "Content-Type": "application/json"},
    json={
        "conversational_experience": {
            "eagerness_to_speak": "balanced",
            "bg_noise": {"enabled": False},
        },
        "settings": {
            "idle_conversation_settings": {
                "idle_call_hangup_timeout": 20,
                "idle_call_hangup_message": "It seems you've stepped away. Goodbye!",
            }
        },
    },
)

{
  "success": true,
  "message": "Experience section updated successfully"
}

Update Agent Experience

Partially update the experience section of an agent. Only the fields you include are merged into the existing config; omitted fields remain unchanged. The experience section controls the conversational feel (background noise, filler words, speaking pace) and call-level settings (idle timeouts, max duration, voicemail detection).

Path Parameters

string

required

UUID of the agent to update.

Body Parameters

object

Settings that shape how the agent sounds and behaves during a conversation.

Show conversational_experience fields

object

Background noise overlay.

Show bg_noise fields

boolean

Turn background noise on or off.

number

Volume level (0–1).

string

Sound preset name (e.g. "office", "cafe").

object

Natural filler words injected into speech.

Show filler_words fields

number

How often to insert filler words (0–1, where 0 = never).

array

Custom list of filler words (e.g. ["um", "uh", "you know"]).

string

How quickly the agent starts speaking after the user stops: "slow" | "balanced" | "fast".

object

Breathing sound configuration (provider-specific shape).

object

Configuration for how long the agent waits for incomplete user input.

object

Map of detected moods to behavioural adjustments.

object

Call-level operational settings.

Show settings fields

object

What the agent does when the call goes quiet.

Show idle_conversation_settings fields

boolean

Send a prompt to check if user is still there.

boolean

Hang up after idle timeout.

integer

Seconds of silence before hanging up (5–60).

integer

Seconds of silence before warning the user (5–60).

string

Message played before hanging up.

string

Message played as the idle warning.

object

Automatic hang-up on a phrase.

Show end_call fields

boolean

Enable phrase-based call ending.

string

Phrase that triggers the hang-up (e.g. "goodbye").

integer

Seconds to wait after the phrase before hanging up.

object

Global call limits.

Show call_settings fields

integer

Maximum call duration in minutes (1–60).

boolean

Enforce the max duration limit.

boolean

Enable voicemail / answering-machine detection.

string

What to do if voicemail is detected: "hang_up" | "leave_message".

string

Message to leave if action is "leave_message".

Request Example

curl -X PATCH https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/experience \
  -H "X-API-Key: vaani_<your_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "conversational_experience": {
      "eagerness_to_speak": "fast",
      "bg_noise": { "enabled": true, "volume": 0.2, "sound": "office" }
    },
    "settings": {
      "call_settings": {
        "max_call_duration": 30,
        "max_duration_enabled": true,
        "enable_voicemail_detection": true,
        "action": "leave_message",
        "end_call_message": "Sorry we missed you, please call back during business hours."
      }
    }
  }'

const response = await fetch(
  "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/experience",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "vaani_<your_key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      conversational_experience: {
        eagerness_to_speak: "fast",
        bg_noise: { enabled: true, volume: 0.2 },
      },
      settings: {
        call_settings: { max_call_duration: 30 },
      },
    }),
  }
);
const data = await response.json();
console.log(data);

import requests

requests.patch(
    "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/experience",
    headers={"X-API-Key": "vaani_<your_key>", "Content-Type": "application/json"},
    json={
        "conversational_experience": {
            "eagerness_to_speak": "balanced",
            "bg_noise": {"enabled": False},
        },
        "settings": {
            "idle_conversation_settings": {
                "idle_call_hangup_timeout": 20,
                "idle_call_hangup_message": "It seems you've stepped away. Goodbye!",
            }
        },
    },
)

Response

{
  "success": true,
  "message": "Experience section updated successfully"
}

Overview

Campaigns

Agents

Calls

Update Agent Experience

Path Parameters

Body Parameters

Request Example

Response

​Update Agent Experience

​Path Parameters

​Body Parameters

​Request Example

​Response

Update Agent Experience

Path Parameters

Body Parameters

Request Example

Response