Update Persona

curl -X PATCH https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/persona \
  -H "X-API-Key: vaani_<your_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "identity": {
      "system_prompt": "You are a helpful customer service agent.",
      "greeting_message": {
        "agent_message": "Hi! How can I help you today?",
        "agent_speech_delay": 1,
        "interruptible": true
      }
    },
    "senses_capabilities": {
      "language": "en",
      "brain": {
        "llm": {
          "primary": {
            "provider": "openai",
            "model": "gpt-4o",
            "parameters": { "temperature": 0.7 }
          }
        }
      }
    }
  }'

const response = await fetch(
  "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/persona",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "vaani_<your_key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      identity: {
        system_prompt: "You are a helpful customer service agent.",
        greeting_message: {
          agent_message: "Hi! How can I help you today?",
          agent_speech_delay: 1,
          interruptible: true,
        },
      },
    }),
  }
);
const data = await response.json();
console.log(data);

import requests

requests.patch(
    "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/persona",
    headers={"X-API-Key": "vaani_<your_key>", "Content-Type": "application/json"},
    json={
        "identity": {
            "system_prompt": "You are a helpful customer service agent.",
            "greeting_message": {
                "agent_message": "Hi! How can I help you today?",
                "agent_speech_delay": 1,
                "interruptible": True,
            },
        }
    },
)

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

PATCH

api

agent

{agent_id}

persona

curl -X PATCH https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/persona \
  -H "X-API-Key: vaani_<your_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "identity": {
      "system_prompt": "You are a helpful customer service agent.",
      "greeting_message": {
        "agent_message": "Hi! How can I help you today?",
        "agent_speech_delay": 1,
        "interruptible": true
      }
    },
    "senses_capabilities": {
      "language": "en",
      "brain": {
        "llm": {
          "primary": {
            "provider": "openai",
            "model": "gpt-4o",
            "parameters": { "temperature": 0.7 }
          }
        }
      }
    }
  }'

const response = await fetch(
  "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/persona",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "vaani_<your_key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      identity: {
        system_prompt: "You are a helpful customer service agent.",
        greeting_message: {
          agent_message: "Hi! How can I help you today?",
          agent_speech_delay: 1,
          interruptible: true,
        },
      },
    }),
  }
);
const data = await response.json();
console.log(data);

import requests

requests.patch(
    "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/persona",
    headers={"X-API-Key": "vaani_<your_key>", "Content-Type": "application/json"},
    json={
        "identity": {
            "system_prompt": "You are a helpful customer service agent.",
            "greeting_message": {
                "agent_message": "Hi! How can I help you today?",
                "agent_speech_delay": 1,
                "interruptible": True,
            },
        }
    },
)

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

Update Agent Persona

Partially update the persona section of an agent. Only the fields you include are deep-merged into the existing configuration; omitted fields are left unchanged. The persona section controls the agent’s identity (system prompt, greeting), AI providers (STT / LLM / TTS), actions, memories, and metadata.

Path Parameters

string

required

UUID of the agent to update.

Body Parameters

object

Core identity settings.

Show identity fields

string

The main system prompt that drives the agent’s behaviour.

object

Key-value map of personality traits (e.g. {"tone": "friendly"}).

object

Controls the opening message spoken by the agent.

Show greeting_message fields

string

Text the agent says at the start of the call.

integer

Delay (seconds, 0–60) before the agent speaks.

integer

Silence gap (seconds, 0–60) after user stops talking.

boolean

Whether the greeting can be interrupted by the user.

boolean

If true, the agent waits for the user to speak before greeting.

object

AI provider configuration for speech-to-text, LLM, and text-to-speech.

Show senses_capabilities fields

string

Primary language code (e.g. "en", "hi").

boolean

Enable automatic language detection.

object

STT (speech-to-text) configuration.

Show ears.stt fields

string

STT provider name.

string

STT model identifier.

string

Language hint for STT.

array

Keywords to boost recognition accuracy.

object

Fallback STT provider (same shape as primary).

object

LLM configuration.

Show brain.llm fields

string

LLM provider name (e.g. "openai").

string

Model identifier (e.g. "gpt-4o").

number

Sampling temperature (0–1).

number

Top-p sampling (0–1).

integer

Max tokens (50–10000).

boolean

Auto-select the best LLM for the detected language.

object

Fallback LLM provider (same shape as primary).

object

TTS (text-to-speech) configuration.

Show mouth.tts fields

string

TTS provider name (e.g. "elevenlabs").

string

TTS model identifier.

string

Voice ID.

string

Voice name.

object

Provider-specific config key-value pairs.

object

Map of words to their preferred pronunciation.

object

Fallback TTS provider (same shape as primary).

object

Custom actions the agent can take during a call (provider-specific shape).

object

Memory configuration for the agent (provider-specific shape).

object

Arbitrary metadata key-value pairs attached to the persona.

Request Example

curl -X PATCH https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/persona \
  -H "X-API-Key: vaani_<your_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "identity": {
      "system_prompt": "You are a helpful customer service agent.",
      "greeting_message": {
        "agent_message": "Hi! How can I help you today?",
        "agent_speech_delay": 1,
        "interruptible": true
      }
    },
    "senses_capabilities": {
      "language": "en",
      "brain": {
        "llm": {
          "primary": {
            "provider": "openai",
            "model": "gpt-4o",
            "parameters": { "temperature": 0.7 }
          }
        }
      }
    }
  }'

const response = await fetch(
  "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/persona",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "vaani_<your_key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      identity: {
        system_prompt: "You are a helpful customer service agent.",
        greeting_message: {
          agent_message: "Hi! How can I help you today?",
          agent_speech_delay: 1,
          interruptible: true,
        },
      },
    }),
  }
);
const data = await response.json();
console.log(data);

import requests

requests.patch(
    "https://api.vaanivoice.ai/api/agent/7ec4155e-0e62-440a-b983-5974f7697854/persona",
    headers={"X-API-Key": "vaani_<your_key>", "Content-Type": "application/json"},
    json={
        "identity": {
            "system_prompt": "You are a helpful customer service agent.",
            "greeting_message": {
                "agent_message": "Hi! How can I help you today?",
                "agent_speech_delay": 1,
                "interruptible": True,
            },
        }
    },
)

Response

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

Overview

Campaigns

Agents

Calls

Update Agent Persona

Path Parameters

Body Parameters

Request Example

Response

​Update Agent Persona

​Path Parameters

​Body Parameters

​Request Example

​Response

Update Agent Persona

Path Parameters

Body Parameters

Request Example

Response