Update staging agent configuration
curl --request POST \
--url 'https://api.vida.dev/api/v2/agent?token=' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"brandName": "<string>",
"agentInstructions": "<string>",
"welcomeMessage": "<string>",
"links": [
"<string>"
],
"keywords": [
"<string>"
],
"agentModel": "<string>",
"agentThinking": "low",
"agentThinkingModel": "<string>",
"postConvoForceThinking": true,
"timezone": "America/Chicago",
"agentVoice": "<string>",
"agentTtsEngine": "<string>",
"agentSttSmartFormatting": true,
"actions": [
{
"name": "<string>",
"instructions": "<string>"
}
],
"reportingFields": [
{
"key": "<string>",
"label": "<string>",
"instructions": "<string>",
"values": {
"choices": [
"<string>"
]
}
}
],
"apps": [
{
"appId": "<string>",
"version": "<string>",
"instructions": "<string>",
"enabled": true
}
],
"skills": [
{
"slug": "<string>",
"instructions": "<string>"
}
],
"computerDelegateAccountId": 123,
"heartbeatInstructions": "<string>",
"heartbeatEvery": "<string>",
"heartbeatConfig": {
"model": "<string>",
"session": "<string>",
"target": "<string>",
"to": "<string>",
"accountId": "<string>",
"includeReasoning": true,
"includeSystemPromptSection": true,
"ackMaxChars": 1,
"suppressToolErrorWarnings": true,
"timeoutSeconds": 2,
"lightContext": true,
"isolatedSession": true,
"skipWhenBusy": true
},
"backgroundAudio": "<string>",
"waitOnAnswer": 1,
"waitToGreet": true,
"postAnswerDtmf": "<string>",
"interruptionWordCount": 1,
"interruptionMinimumSpeakingTime": 1,
"speakingTimeout": 1,
"speechProcessingDelay": 1,
"speechProcessingDelayInterruptionStep": 1,
"speechProcessingDelayMaxMultiplier": 1,
"callerResponseTimeout": 1,
"callerResponseTimeoutHangupCounter": 1,
"ignoreSpeech": [
"<string>"
],
"noContactInjection": true,
"noConvoHistory": true,
"recordingNotificationPhrase": "<string>",
"preAnswerRingTime": 30,
"preAnswerSkipProcessingResults": true,
"useAgentNumberForTransfers": true,
"confirmTransfers": true,
"monitorTransfers": true,
"attendedTransfers": true,
"attendedTransferBridgeTrigger": "<string>",
"attendedTransferCheckInTimeout": 1,
"transferConfirmTimeout": 1,
"announceTransferConnecting": true,
"announceTransferConnected": true,
"preTransferNotificationStart": "<string>",
"preTransferNotificationEnd": "<string>",
"enableRingback": true,
"enableTransferRingback": true,
"cnamAutoRejectRegex": "<string>",
"cnamAutoRejectCode": 123,
"cnamAutoTransferRegex": "<string>",
"cnamAutoTransferDestination": "<string>"
}
'import requests
url = "https://api.vida.dev/api/v2/agent?token="
payload = {
"title": "<string>",
"description": "<string>",
"brandName": "<string>",
"agentInstructions": "<string>",
"welcomeMessage": "<string>",
"links": ["<string>"],
"keywords": ["<string>"],
"agentModel": "<string>",
"agentThinking": "low",
"agentThinkingModel": "<string>",
"postConvoForceThinking": True,
"timezone": "America/Chicago",
"agentVoice": "<string>",
"agentTtsEngine": "<string>",
"agentSttSmartFormatting": True,
"actions": [
{
"name": "<string>",
"instructions": "<string>"
}
],
"reportingFields": [
{
"key": "<string>",
"label": "<string>",
"instructions": "<string>",
"values": { "choices": ["<string>"] }
}
],
"apps": [
{
"appId": "<string>",
"version": "<string>",
"instructions": "<string>",
"enabled": True
}
],
"skills": [
{
"slug": "<string>",
"instructions": "<string>"
}
],
"computerDelegateAccountId": 123,
"heartbeatInstructions": "<string>",
"heartbeatEvery": "<string>",
"heartbeatConfig": {
"model": "<string>",
"session": "<string>",
"target": "<string>",
"to": "<string>",
"accountId": "<string>",
"includeReasoning": True,
"includeSystemPromptSection": True,
"ackMaxChars": 1,
"suppressToolErrorWarnings": True,
"timeoutSeconds": 2,
"lightContext": True,
"isolatedSession": True,
"skipWhenBusy": True
},
"backgroundAudio": "<string>",
"waitOnAnswer": 1,
"waitToGreet": True,
"postAnswerDtmf": "<string>",
"interruptionWordCount": 1,
"interruptionMinimumSpeakingTime": 1,
"speakingTimeout": 1,
"speechProcessingDelay": 1,
"speechProcessingDelayInterruptionStep": 1,
"speechProcessingDelayMaxMultiplier": 1,
"callerResponseTimeout": 1,
"callerResponseTimeoutHangupCounter": 1,
"ignoreSpeech": ["<string>"],
"noContactInjection": True,
"noConvoHistory": True,
"recordingNotificationPhrase": "<string>",
"preAnswerRingTime": 30,
"preAnswerSkipProcessingResults": True,
"useAgentNumberForTransfers": True,
"confirmTransfers": True,
"monitorTransfers": True,
"attendedTransfers": True,
"attendedTransferBridgeTrigger": "<string>",
"attendedTransferCheckInTimeout": 1,
"transferConfirmTimeout": 1,
"announceTransferConnecting": True,
"announceTransferConnected": True,
"preTransferNotificationStart": "<string>",
"preTransferNotificationEnd": "<string>",
"enableRingback": True,
"enableTransferRingback": True,
"cnamAutoRejectRegex": "<string>",
"cnamAutoRejectCode": 123,
"cnamAutoTransferRegex": "<string>",
"cnamAutoTransferDestination": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
brandName: '<string>',
agentInstructions: '<string>',
welcomeMessage: '<string>',
links: ['<string>'],
keywords: ['<string>'],
agentModel: '<string>',
agentThinking: 'low',
agentThinkingModel: '<string>',
postConvoForceThinking: true,
timezone: 'America/Chicago',
agentVoice: '<string>',
agentTtsEngine: '<string>',
agentSttSmartFormatting: true,
actions: [{name: '<string>', instructions: '<string>'}],
reportingFields: [
{
key: '<string>',
label: '<string>',
instructions: '<string>',
values: {choices: ['<string>']}
}
],
apps: [
{
appId: '<string>',
version: '<string>',
instructions: '<string>',
enabled: true
}
],
skills: [{slug: '<string>', instructions: '<string>'}],
computerDelegateAccountId: 123,
heartbeatInstructions: '<string>',
heartbeatEvery: '<string>',
heartbeatConfig: {
model: '<string>',
session: '<string>',
target: '<string>',
to: '<string>',
accountId: '<string>',
includeReasoning: true,
includeSystemPromptSection: true,
ackMaxChars: 1,
suppressToolErrorWarnings: true,
timeoutSeconds: 2,
lightContext: true,
isolatedSession: true,
skipWhenBusy: true
},
backgroundAudio: '<string>',
waitOnAnswer: 1,
waitToGreet: true,
postAnswerDtmf: '<string>',
interruptionWordCount: 1,
interruptionMinimumSpeakingTime: 1,
speakingTimeout: 1,
speechProcessingDelay: 1,
speechProcessingDelayInterruptionStep: 1,
speechProcessingDelayMaxMultiplier: 1,
callerResponseTimeout: 1,
callerResponseTimeoutHangupCounter: 1,
ignoreSpeech: ['<string>'],
noContactInjection: true,
noConvoHistory: true,
recordingNotificationPhrase: '<string>',
preAnswerRingTime: 30,
preAnswerSkipProcessingResults: true,
useAgentNumberForTransfers: true,
confirmTransfers: true,
monitorTransfers: true,
attendedTransfers: true,
attendedTransferBridgeTrigger: '<string>',
attendedTransferCheckInTimeout: 1,
transferConfirmTimeout: 1,
announceTransferConnecting: true,
announceTransferConnected: true,
preTransferNotificationStart: '<string>',
preTransferNotificationEnd: '<string>',
enableRingback: true,
enableTransferRingback: true,
cnamAutoRejectRegex: '<string>',
cnamAutoRejectCode: 123,
cnamAutoTransferRegex: '<string>',
cnamAutoTransferDestination: '<string>'
})
};
fetch('https://api.vida.dev/api/v2/agent?token=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vida.dev/api/v2/agent?token=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'description' => '<string>',
'brandName' => '<string>',
'agentInstructions' => '<string>',
'welcomeMessage' => '<string>',
'links' => [
'<string>'
],
'keywords' => [
'<string>'
],
'agentModel' => '<string>',
'agentThinking' => 'low',
'agentThinkingModel' => '<string>',
'postConvoForceThinking' => true,
'timezone' => 'America/Chicago',
'agentVoice' => '<string>',
'agentTtsEngine' => '<string>',
'agentSttSmartFormatting' => true,
'actions' => [
[
'name' => '<string>',
'instructions' => '<string>'
]
],
'reportingFields' => [
[
'key' => '<string>',
'label' => '<string>',
'instructions' => '<string>',
'values' => [
'choices' => [
'<string>'
]
]
]
],
'apps' => [
[
'appId' => '<string>',
'version' => '<string>',
'instructions' => '<string>',
'enabled' => true
]
],
'skills' => [
[
'slug' => '<string>',
'instructions' => '<string>'
]
],
'computerDelegateAccountId' => 123,
'heartbeatInstructions' => '<string>',
'heartbeatEvery' => '<string>',
'heartbeatConfig' => [
'model' => '<string>',
'session' => '<string>',
'target' => '<string>',
'to' => '<string>',
'accountId' => '<string>',
'includeReasoning' => true,
'includeSystemPromptSection' => true,
'ackMaxChars' => 1,
'suppressToolErrorWarnings' => true,
'timeoutSeconds' => 2,
'lightContext' => true,
'isolatedSession' => true,
'skipWhenBusy' => true
],
'backgroundAudio' => '<string>',
'waitOnAnswer' => 1,
'waitToGreet' => true,
'postAnswerDtmf' => '<string>',
'interruptionWordCount' => 1,
'interruptionMinimumSpeakingTime' => 1,
'speakingTimeout' => 1,
'speechProcessingDelay' => 1,
'speechProcessingDelayInterruptionStep' => 1,
'speechProcessingDelayMaxMultiplier' => 1,
'callerResponseTimeout' => 1,
'callerResponseTimeoutHangupCounter' => 1,
'ignoreSpeech' => [
'<string>'
],
'noContactInjection' => true,
'noConvoHistory' => true,
'recordingNotificationPhrase' => '<string>',
'preAnswerRingTime' => 30,
'preAnswerSkipProcessingResults' => true,
'useAgentNumberForTransfers' => true,
'confirmTransfers' => true,
'monitorTransfers' => true,
'attendedTransfers' => true,
'attendedTransferBridgeTrigger' => '<string>',
'attendedTransferCheckInTimeout' => 1,
'transferConfirmTimeout' => 1,
'announceTransferConnecting' => true,
'announceTransferConnected' => true,
'preTransferNotificationStart' => '<string>',
'preTransferNotificationEnd' => '<string>',
'enableRingback' => true,
'enableTransferRingback' => true,
'cnamAutoRejectRegex' => '<string>',
'cnamAutoRejectCode' => 123,
'cnamAutoTransferRegex' => '<string>',
'cnamAutoTransferDestination' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vida.dev/api/v2/agent?token="
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"brandName\": \"<string>\",\n \"agentInstructions\": \"<string>\",\n \"welcomeMessage\": \"<string>\",\n \"links\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"agentModel\": \"<string>\",\n \"agentThinking\": \"low\",\n \"agentThinkingModel\": \"<string>\",\n \"postConvoForceThinking\": true,\n \"timezone\": \"America/Chicago\",\n \"agentVoice\": \"<string>\",\n \"agentTtsEngine\": \"<string>\",\n \"agentSttSmartFormatting\": true,\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"reportingFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"instructions\": \"<string>\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"apps\": [\n {\n \"appId\": \"<string>\",\n \"version\": \"<string>\",\n \"instructions\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"skills\": [\n {\n \"slug\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"computerDelegateAccountId\": 123,\n \"heartbeatInstructions\": \"<string>\",\n \"heartbeatEvery\": \"<string>\",\n \"heartbeatConfig\": {\n \"model\": \"<string>\",\n \"session\": \"<string>\",\n \"target\": \"<string>\",\n \"to\": \"<string>\",\n \"accountId\": \"<string>\",\n \"includeReasoning\": true,\n \"includeSystemPromptSection\": true,\n \"ackMaxChars\": 1,\n \"suppressToolErrorWarnings\": true,\n \"timeoutSeconds\": 2,\n \"lightContext\": true,\n \"isolatedSession\": true,\n \"skipWhenBusy\": true\n },\n \"backgroundAudio\": \"<string>\",\n \"waitOnAnswer\": 1,\n \"waitToGreet\": true,\n \"postAnswerDtmf\": \"<string>\",\n \"interruptionWordCount\": 1,\n \"interruptionMinimumSpeakingTime\": 1,\n \"speakingTimeout\": 1,\n \"speechProcessingDelay\": 1,\n \"speechProcessingDelayInterruptionStep\": 1,\n \"speechProcessingDelayMaxMultiplier\": 1,\n \"callerResponseTimeout\": 1,\n \"callerResponseTimeoutHangupCounter\": 1,\n \"ignoreSpeech\": [\n \"<string>\"\n ],\n \"noContactInjection\": true,\n \"noConvoHistory\": true,\n \"recordingNotificationPhrase\": \"<string>\",\n \"preAnswerRingTime\": 30,\n \"preAnswerSkipProcessingResults\": true,\n \"useAgentNumberForTransfers\": true,\n \"confirmTransfers\": true,\n \"monitorTransfers\": true,\n \"attendedTransfers\": true,\n \"attendedTransferBridgeTrigger\": \"<string>\",\n \"attendedTransferCheckInTimeout\": 1,\n \"transferConfirmTimeout\": 1,\n \"announceTransferConnecting\": true,\n \"announceTransferConnected\": true,\n \"preTransferNotificationStart\": \"<string>\",\n \"preTransferNotificationEnd\": \"<string>\",\n \"enableRingback\": true,\n \"enableTransferRingback\": true,\n \"cnamAutoRejectRegex\": \"<string>\",\n \"cnamAutoRejectCode\": 123,\n \"cnamAutoTransferRegex\": \"<string>\",\n \"cnamAutoTransferDestination\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vida.dev/api/v2/agent?token=")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"brandName\": \"<string>\",\n \"agentInstructions\": \"<string>\",\n \"welcomeMessage\": \"<string>\",\n \"links\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"agentModel\": \"<string>\",\n \"agentThinking\": \"low\",\n \"agentThinkingModel\": \"<string>\",\n \"postConvoForceThinking\": true,\n \"timezone\": \"America/Chicago\",\n \"agentVoice\": \"<string>\",\n \"agentTtsEngine\": \"<string>\",\n \"agentSttSmartFormatting\": true,\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"reportingFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"instructions\": \"<string>\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"apps\": [\n {\n \"appId\": \"<string>\",\n \"version\": \"<string>\",\n \"instructions\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"skills\": [\n {\n \"slug\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"computerDelegateAccountId\": 123,\n \"heartbeatInstructions\": \"<string>\",\n \"heartbeatEvery\": \"<string>\",\n \"heartbeatConfig\": {\n \"model\": \"<string>\",\n \"session\": \"<string>\",\n \"target\": \"<string>\",\n \"to\": \"<string>\",\n \"accountId\": \"<string>\",\n \"includeReasoning\": true,\n \"includeSystemPromptSection\": true,\n \"ackMaxChars\": 1,\n \"suppressToolErrorWarnings\": true,\n \"timeoutSeconds\": 2,\n \"lightContext\": true,\n \"isolatedSession\": true,\n \"skipWhenBusy\": true\n },\n \"backgroundAudio\": \"<string>\",\n \"waitOnAnswer\": 1,\n \"waitToGreet\": true,\n \"postAnswerDtmf\": \"<string>\",\n \"interruptionWordCount\": 1,\n \"interruptionMinimumSpeakingTime\": 1,\n \"speakingTimeout\": 1,\n \"speechProcessingDelay\": 1,\n \"speechProcessingDelayInterruptionStep\": 1,\n \"speechProcessingDelayMaxMultiplier\": 1,\n \"callerResponseTimeout\": 1,\n \"callerResponseTimeoutHangupCounter\": 1,\n \"ignoreSpeech\": [\n \"<string>\"\n ],\n \"noContactInjection\": true,\n \"noConvoHistory\": true,\n \"recordingNotificationPhrase\": \"<string>\",\n \"preAnswerRingTime\": 30,\n \"preAnswerSkipProcessingResults\": true,\n \"useAgentNumberForTransfers\": true,\n \"confirmTransfers\": true,\n \"monitorTransfers\": true,\n \"attendedTransfers\": true,\n \"attendedTransferBridgeTrigger\": \"<string>\",\n \"attendedTransferCheckInTimeout\": 1,\n \"transferConfirmTimeout\": 1,\n \"announceTransferConnecting\": true,\n \"announceTransferConnected\": true,\n \"preTransferNotificationStart\": \"<string>\",\n \"preTransferNotificationEnd\": \"<string>\",\n \"enableRingback\": true,\n \"enableTransferRingback\": true,\n \"cnamAutoRejectRegex\": \"<string>\",\n \"cnamAutoRejectCode\": 123,\n \"cnamAutoTransferRegex\": \"<string>\",\n \"cnamAutoTransferDestination\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/agent?token=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"brandName\": \"<string>\",\n \"agentInstructions\": \"<string>\",\n \"welcomeMessage\": \"<string>\",\n \"links\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"agentModel\": \"<string>\",\n \"agentThinking\": \"low\",\n \"agentThinkingModel\": \"<string>\",\n \"postConvoForceThinking\": true,\n \"timezone\": \"America/Chicago\",\n \"agentVoice\": \"<string>\",\n \"agentTtsEngine\": \"<string>\",\n \"agentSttSmartFormatting\": true,\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"reportingFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"instructions\": \"<string>\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"apps\": [\n {\n \"appId\": \"<string>\",\n \"version\": \"<string>\",\n \"instructions\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"skills\": [\n {\n \"slug\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"computerDelegateAccountId\": 123,\n \"heartbeatInstructions\": \"<string>\",\n \"heartbeatEvery\": \"<string>\",\n \"heartbeatConfig\": {\n \"model\": \"<string>\",\n \"session\": \"<string>\",\n \"target\": \"<string>\",\n \"to\": \"<string>\",\n \"accountId\": \"<string>\",\n \"includeReasoning\": true,\n \"includeSystemPromptSection\": true,\n \"ackMaxChars\": 1,\n \"suppressToolErrorWarnings\": true,\n \"timeoutSeconds\": 2,\n \"lightContext\": true,\n \"isolatedSession\": true,\n \"skipWhenBusy\": true\n },\n \"backgroundAudio\": \"<string>\",\n \"waitOnAnswer\": 1,\n \"waitToGreet\": true,\n \"postAnswerDtmf\": \"<string>\",\n \"interruptionWordCount\": 1,\n \"interruptionMinimumSpeakingTime\": 1,\n \"speakingTimeout\": 1,\n \"speechProcessingDelay\": 1,\n \"speechProcessingDelayInterruptionStep\": 1,\n \"speechProcessingDelayMaxMultiplier\": 1,\n \"callerResponseTimeout\": 1,\n \"callerResponseTimeoutHangupCounter\": 1,\n \"ignoreSpeech\": [\n \"<string>\"\n ],\n \"noContactInjection\": true,\n \"noConvoHistory\": true,\n \"recordingNotificationPhrase\": \"<string>\",\n \"preAnswerRingTime\": 30,\n \"preAnswerSkipProcessingResults\": true,\n \"useAgentNumberForTransfers\": true,\n \"confirmTransfers\": true,\n \"monitorTransfers\": true,\n \"attendedTransfers\": true,\n \"attendedTransferBridgeTrigger\": \"<string>\",\n \"attendedTransferCheckInTimeout\": 1,\n \"transferConfirmTimeout\": 1,\n \"announceTransferConnecting\": true,\n \"announceTransferConnected\": true,\n \"preTransferNotificationStart\": \"<string>\",\n \"preTransferNotificationEnd\": \"<string>\",\n \"enableRingback\": true,\n \"enableTransferRingback\": true,\n \"cnamAutoRejectRegex\": \"<string>\",\n \"cnamAutoRejectCode\": 123,\n \"cnamAutoTransferRegex\": \"<string>\",\n \"cnamAutoTransferDestination\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Campaign updated successfully"
}Agents
Update staging agent configuration
Updates the selected account staging configuration. Omitted settings retain their current values. Publish separately when the staged changes are ready to become live.
POST
/
api
/
v2
/
agent
Update staging agent configuration
curl --request POST \
--url 'https://api.vida.dev/api/v2/agent?token=' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"brandName": "<string>",
"agentInstructions": "<string>",
"welcomeMessage": "<string>",
"links": [
"<string>"
],
"keywords": [
"<string>"
],
"agentModel": "<string>",
"agentThinking": "low",
"agentThinkingModel": "<string>",
"postConvoForceThinking": true,
"timezone": "America/Chicago",
"agentVoice": "<string>",
"agentTtsEngine": "<string>",
"agentSttSmartFormatting": true,
"actions": [
{
"name": "<string>",
"instructions": "<string>"
}
],
"reportingFields": [
{
"key": "<string>",
"label": "<string>",
"instructions": "<string>",
"values": {
"choices": [
"<string>"
]
}
}
],
"apps": [
{
"appId": "<string>",
"version": "<string>",
"instructions": "<string>",
"enabled": true
}
],
"skills": [
{
"slug": "<string>",
"instructions": "<string>"
}
],
"computerDelegateAccountId": 123,
"heartbeatInstructions": "<string>",
"heartbeatEvery": "<string>",
"heartbeatConfig": {
"model": "<string>",
"session": "<string>",
"target": "<string>",
"to": "<string>",
"accountId": "<string>",
"includeReasoning": true,
"includeSystemPromptSection": true,
"ackMaxChars": 1,
"suppressToolErrorWarnings": true,
"timeoutSeconds": 2,
"lightContext": true,
"isolatedSession": true,
"skipWhenBusy": true
},
"backgroundAudio": "<string>",
"waitOnAnswer": 1,
"waitToGreet": true,
"postAnswerDtmf": "<string>",
"interruptionWordCount": 1,
"interruptionMinimumSpeakingTime": 1,
"speakingTimeout": 1,
"speechProcessingDelay": 1,
"speechProcessingDelayInterruptionStep": 1,
"speechProcessingDelayMaxMultiplier": 1,
"callerResponseTimeout": 1,
"callerResponseTimeoutHangupCounter": 1,
"ignoreSpeech": [
"<string>"
],
"noContactInjection": true,
"noConvoHistory": true,
"recordingNotificationPhrase": "<string>",
"preAnswerRingTime": 30,
"preAnswerSkipProcessingResults": true,
"useAgentNumberForTransfers": true,
"confirmTransfers": true,
"monitorTransfers": true,
"attendedTransfers": true,
"attendedTransferBridgeTrigger": "<string>",
"attendedTransferCheckInTimeout": 1,
"transferConfirmTimeout": 1,
"announceTransferConnecting": true,
"announceTransferConnected": true,
"preTransferNotificationStart": "<string>",
"preTransferNotificationEnd": "<string>",
"enableRingback": true,
"enableTransferRingback": true,
"cnamAutoRejectRegex": "<string>",
"cnamAutoRejectCode": 123,
"cnamAutoTransferRegex": "<string>",
"cnamAutoTransferDestination": "<string>"
}
'import requests
url = "https://api.vida.dev/api/v2/agent?token="
payload = {
"title": "<string>",
"description": "<string>",
"brandName": "<string>",
"agentInstructions": "<string>",
"welcomeMessage": "<string>",
"links": ["<string>"],
"keywords": ["<string>"],
"agentModel": "<string>",
"agentThinking": "low",
"agentThinkingModel": "<string>",
"postConvoForceThinking": True,
"timezone": "America/Chicago",
"agentVoice": "<string>",
"agentTtsEngine": "<string>",
"agentSttSmartFormatting": True,
"actions": [
{
"name": "<string>",
"instructions": "<string>"
}
],
"reportingFields": [
{
"key": "<string>",
"label": "<string>",
"instructions": "<string>",
"values": { "choices": ["<string>"] }
}
],
"apps": [
{
"appId": "<string>",
"version": "<string>",
"instructions": "<string>",
"enabled": True
}
],
"skills": [
{
"slug": "<string>",
"instructions": "<string>"
}
],
"computerDelegateAccountId": 123,
"heartbeatInstructions": "<string>",
"heartbeatEvery": "<string>",
"heartbeatConfig": {
"model": "<string>",
"session": "<string>",
"target": "<string>",
"to": "<string>",
"accountId": "<string>",
"includeReasoning": True,
"includeSystemPromptSection": True,
"ackMaxChars": 1,
"suppressToolErrorWarnings": True,
"timeoutSeconds": 2,
"lightContext": True,
"isolatedSession": True,
"skipWhenBusy": True
},
"backgroundAudio": "<string>",
"waitOnAnswer": 1,
"waitToGreet": True,
"postAnswerDtmf": "<string>",
"interruptionWordCount": 1,
"interruptionMinimumSpeakingTime": 1,
"speakingTimeout": 1,
"speechProcessingDelay": 1,
"speechProcessingDelayInterruptionStep": 1,
"speechProcessingDelayMaxMultiplier": 1,
"callerResponseTimeout": 1,
"callerResponseTimeoutHangupCounter": 1,
"ignoreSpeech": ["<string>"],
"noContactInjection": True,
"noConvoHistory": True,
"recordingNotificationPhrase": "<string>",
"preAnswerRingTime": 30,
"preAnswerSkipProcessingResults": True,
"useAgentNumberForTransfers": True,
"confirmTransfers": True,
"monitorTransfers": True,
"attendedTransfers": True,
"attendedTransferBridgeTrigger": "<string>",
"attendedTransferCheckInTimeout": 1,
"transferConfirmTimeout": 1,
"announceTransferConnecting": True,
"announceTransferConnected": True,
"preTransferNotificationStart": "<string>",
"preTransferNotificationEnd": "<string>",
"enableRingback": True,
"enableTransferRingback": True,
"cnamAutoRejectRegex": "<string>",
"cnamAutoRejectCode": 123,
"cnamAutoTransferRegex": "<string>",
"cnamAutoTransferDestination": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
brandName: '<string>',
agentInstructions: '<string>',
welcomeMessage: '<string>',
links: ['<string>'],
keywords: ['<string>'],
agentModel: '<string>',
agentThinking: 'low',
agentThinkingModel: '<string>',
postConvoForceThinking: true,
timezone: 'America/Chicago',
agentVoice: '<string>',
agentTtsEngine: '<string>',
agentSttSmartFormatting: true,
actions: [{name: '<string>', instructions: '<string>'}],
reportingFields: [
{
key: '<string>',
label: '<string>',
instructions: '<string>',
values: {choices: ['<string>']}
}
],
apps: [
{
appId: '<string>',
version: '<string>',
instructions: '<string>',
enabled: true
}
],
skills: [{slug: '<string>', instructions: '<string>'}],
computerDelegateAccountId: 123,
heartbeatInstructions: '<string>',
heartbeatEvery: '<string>',
heartbeatConfig: {
model: '<string>',
session: '<string>',
target: '<string>',
to: '<string>',
accountId: '<string>',
includeReasoning: true,
includeSystemPromptSection: true,
ackMaxChars: 1,
suppressToolErrorWarnings: true,
timeoutSeconds: 2,
lightContext: true,
isolatedSession: true,
skipWhenBusy: true
},
backgroundAudio: '<string>',
waitOnAnswer: 1,
waitToGreet: true,
postAnswerDtmf: '<string>',
interruptionWordCount: 1,
interruptionMinimumSpeakingTime: 1,
speakingTimeout: 1,
speechProcessingDelay: 1,
speechProcessingDelayInterruptionStep: 1,
speechProcessingDelayMaxMultiplier: 1,
callerResponseTimeout: 1,
callerResponseTimeoutHangupCounter: 1,
ignoreSpeech: ['<string>'],
noContactInjection: true,
noConvoHistory: true,
recordingNotificationPhrase: '<string>',
preAnswerRingTime: 30,
preAnswerSkipProcessingResults: true,
useAgentNumberForTransfers: true,
confirmTransfers: true,
monitorTransfers: true,
attendedTransfers: true,
attendedTransferBridgeTrigger: '<string>',
attendedTransferCheckInTimeout: 1,
transferConfirmTimeout: 1,
announceTransferConnecting: true,
announceTransferConnected: true,
preTransferNotificationStart: '<string>',
preTransferNotificationEnd: '<string>',
enableRingback: true,
enableTransferRingback: true,
cnamAutoRejectRegex: '<string>',
cnamAutoRejectCode: 123,
cnamAutoTransferRegex: '<string>',
cnamAutoTransferDestination: '<string>'
})
};
fetch('https://api.vida.dev/api/v2/agent?token=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vida.dev/api/v2/agent?token=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'description' => '<string>',
'brandName' => '<string>',
'agentInstructions' => '<string>',
'welcomeMessage' => '<string>',
'links' => [
'<string>'
],
'keywords' => [
'<string>'
],
'agentModel' => '<string>',
'agentThinking' => 'low',
'agentThinkingModel' => '<string>',
'postConvoForceThinking' => true,
'timezone' => 'America/Chicago',
'agentVoice' => '<string>',
'agentTtsEngine' => '<string>',
'agentSttSmartFormatting' => true,
'actions' => [
[
'name' => '<string>',
'instructions' => '<string>'
]
],
'reportingFields' => [
[
'key' => '<string>',
'label' => '<string>',
'instructions' => '<string>',
'values' => [
'choices' => [
'<string>'
]
]
]
],
'apps' => [
[
'appId' => '<string>',
'version' => '<string>',
'instructions' => '<string>',
'enabled' => true
]
],
'skills' => [
[
'slug' => '<string>',
'instructions' => '<string>'
]
],
'computerDelegateAccountId' => 123,
'heartbeatInstructions' => '<string>',
'heartbeatEvery' => '<string>',
'heartbeatConfig' => [
'model' => '<string>',
'session' => '<string>',
'target' => '<string>',
'to' => '<string>',
'accountId' => '<string>',
'includeReasoning' => true,
'includeSystemPromptSection' => true,
'ackMaxChars' => 1,
'suppressToolErrorWarnings' => true,
'timeoutSeconds' => 2,
'lightContext' => true,
'isolatedSession' => true,
'skipWhenBusy' => true
],
'backgroundAudio' => '<string>',
'waitOnAnswer' => 1,
'waitToGreet' => true,
'postAnswerDtmf' => '<string>',
'interruptionWordCount' => 1,
'interruptionMinimumSpeakingTime' => 1,
'speakingTimeout' => 1,
'speechProcessingDelay' => 1,
'speechProcessingDelayInterruptionStep' => 1,
'speechProcessingDelayMaxMultiplier' => 1,
'callerResponseTimeout' => 1,
'callerResponseTimeoutHangupCounter' => 1,
'ignoreSpeech' => [
'<string>'
],
'noContactInjection' => true,
'noConvoHistory' => true,
'recordingNotificationPhrase' => '<string>',
'preAnswerRingTime' => 30,
'preAnswerSkipProcessingResults' => true,
'useAgentNumberForTransfers' => true,
'confirmTransfers' => true,
'monitorTransfers' => true,
'attendedTransfers' => true,
'attendedTransferBridgeTrigger' => '<string>',
'attendedTransferCheckInTimeout' => 1,
'transferConfirmTimeout' => 1,
'announceTransferConnecting' => true,
'announceTransferConnected' => true,
'preTransferNotificationStart' => '<string>',
'preTransferNotificationEnd' => '<string>',
'enableRingback' => true,
'enableTransferRingback' => true,
'cnamAutoRejectRegex' => '<string>',
'cnamAutoRejectCode' => 123,
'cnamAutoTransferRegex' => '<string>',
'cnamAutoTransferDestination' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vida.dev/api/v2/agent?token="
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"brandName\": \"<string>\",\n \"agentInstructions\": \"<string>\",\n \"welcomeMessage\": \"<string>\",\n \"links\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"agentModel\": \"<string>\",\n \"agentThinking\": \"low\",\n \"agentThinkingModel\": \"<string>\",\n \"postConvoForceThinking\": true,\n \"timezone\": \"America/Chicago\",\n \"agentVoice\": \"<string>\",\n \"agentTtsEngine\": \"<string>\",\n \"agentSttSmartFormatting\": true,\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"reportingFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"instructions\": \"<string>\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"apps\": [\n {\n \"appId\": \"<string>\",\n \"version\": \"<string>\",\n \"instructions\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"skills\": [\n {\n \"slug\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"computerDelegateAccountId\": 123,\n \"heartbeatInstructions\": \"<string>\",\n \"heartbeatEvery\": \"<string>\",\n \"heartbeatConfig\": {\n \"model\": \"<string>\",\n \"session\": \"<string>\",\n \"target\": \"<string>\",\n \"to\": \"<string>\",\n \"accountId\": \"<string>\",\n \"includeReasoning\": true,\n \"includeSystemPromptSection\": true,\n \"ackMaxChars\": 1,\n \"suppressToolErrorWarnings\": true,\n \"timeoutSeconds\": 2,\n \"lightContext\": true,\n \"isolatedSession\": true,\n \"skipWhenBusy\": true\n },\n \"backgroundAudio\": \"<string>\",\n \"waitOnAnswer\": 1,\n \"waitToGreet\": true,\n \"postAnswerDtmf\": \"<string>\",\n \"interruptionWordCount\": 1,\n \"interruptionMinimumSpeakingTime\": 1,\n \"speakingTimeout\": 1,\n \"speechProcessingDelay\": 1,\n \"speechProcessingDelayInterruptionStep\": 1,\n \"speechProcessingDelayMaxMultiplier\": 1,\n \"callerResponseTimeout\": 1,\n \"callerResponseTimeoutHangupCounter\": 1,\n \"ignoreSpeech\": [\n \"<string>\"\n ],\n \"noContactInjection\": true,\n \"noConvoHistory\": true,\n \"recordingNotificationPhrase\": \"<string>\",\n \"preAnswerRingTime\": 30,\n \"preAnswerSkipProcessingResults\": true,\n \"useAgentNumberForTransfers\": true,\n \"confirmTransfers\": true,\n \"monitorTransfers\": true,\n \"attendedTransfers\": true,\n \"attendedTransferBridgeTrigger\": \"<string>\",\n \"attendedTransferCheckInTimeout\": 1,\n \"transferConfirmTimeout\": 1,\n \"announceTransferConnecting\": true,\n \"announceTransferConnected\": true,\n \"preTransferNotificationStart\": \"<string>\",\n \"preTransferNotificationEnd\": \"<string>\",\n \"enableRingback\": true,\n \"enableTransferRingback\": true,\n \"cnamAutoRejectRegex\": \"<string>\",\n \"cnamAutoRejectCode\": 123,\n \"cnamAutoTransferRegex\": \"<string>\",\n \"cnamAutoTransferDestination\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vida.dev/api/v2/agent?token=")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"brandName\": \"<string>\",\n \"agentInstructions\": \"<string>\",\n \"welcomeMessage\": \"<string>\",\n \"links\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"agentModel\": \"<string>\",\n \"agentThinking\": \"low\",\n \"agentThinkingModel\": \"<string>\",\n \"postConvoForceThinking\": true,\n \"timezone\": \"America/Chicago\",\n \"agentVoice\": \"<string>\",\n \"agentTtsEngine\": \"<string>\",\n \"agentSttSmartFormatting\": true,\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"reportingFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"instructions\": \"<string>\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"apps\": [\n {\n \"appId\": \"<string>\",\n \"version\": \"<string>\",\n \"instructions\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"skills\": [\n {\n \"slug\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"computerDelegateAccountId\": 123,\n \"heartbeatInstructions\": \"<string>\",\n \"heartbeatEvery\": \"<string>\",\n \"heartbeatConfig\": {\n \"model\": \"<string>\",\n \"session\": \"<string>\",\n \"target\": \"<string>\",\n \"to\": \"<string>\",\n \"accountId\": \"<string>\",\n \"includeReasoning\": true,\n \"includeSystemPromptSection\": true,\n \"ackMaxChars\": 1,\n \"suppressToolErrorWarnings\": true,\n \"timeoutSeconds\": 2,\n \"lightContext\": true,\n \"isolatedSession\": true,\n \"skipWhenBusy\": true\n },\n \"backgroundAudio\": \"<string>\",\n \"waitOnAnswer\": 1,\n \"waitToGreet\": true,\n \"postAnswerDtmf\": \"<string>\",\n \"interruptionWordCount\": 1,\n \"interruptionMinimumSpeakingTime\": 1,\n \"speakingTimeout\": 1,\n \"speechProcessingDelay\": 1,\n \"speechProcessingDelayInterruptionStep\": 1,\n \"speechProcessingDelayMaxMultiplier\": 1,\n \"callerResponseTimeout\": 1,\n \"callerResponseTimeoutHangupCounter\": 1,\n \"ignoreSpeech\": [\n \"<string>\"\n ],\n \"noContactInjection\": true,\n \"noConvoHistory\": true,\n \"recordingNotificationPhrase\": \"<string>\",\n \"preAnswerRingTime\": 30,\n \"preAnswerSkipProcessingResults\": true,\n \"useAgentNumberForTransfers\": true,\n \"confirmTransfers\": true,\n \"monitorTransfers\": true,\n \"attendedTransfers\": true,\n \"attendedTransferBridgeTrigger\": \"<string>\",\n \"attendedTransferCheckInTimeout\": 1,\n \"transferConfirmTimeout\": 1,\n \"announceTransferConnecting\": true,\n \"announceTransferConnected\": true,\n \"preTransferNotificationStart\": \"<string>\",\n \"preTransferNotificationEnd\": \"<string>\",\n \"enableRingback\": true,\n \"enableTransferRingback\": true,\n \"cnamAutoRejectRegex\": \"<string>\",\n \"cnamAutoRejectCode\": 123,\n \"cnamAutoTransferRegex\": \"<string>\",\n \"cnamAutoTransferDestination\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/agent?token=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"brandName\": \"<string>\",\n \"agentInstructions\": \"<string>\",\n \"welcomeMessage\": \"<string>\",\n \"links\": [\n \"<string>\"\n ],\n \"keywords\": [\n \"<string>\"\n ],\n \"agentModel\": \"<string>\",\n \"agentThinking\": \"low\",\n \"agentThinkingModel\": \"<string>\",\n \"postConvoForceThinking\": true,\n \"timezone\": \"America/Chicago\",\n \"agentVoice\": \"<string>\",\n \"agentTtsEngine\": \"<string>\",\n \"agentSttSmartFormatting\": true,\n \"actions\": [\n {\n \"name\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"reportingFields\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"instructions\": \"<string>\",\n \"values\": {\n \"choices\": [\n \"<string>\"\n ]\n }\n }\n ],\n \"apps\": [\n {\n \"appId\": \"<string>\",\n \"version\": \"<string>\",\n \"instructions\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"skills\": [\n {\n \"slug\": \"<string>\",\n \"instructions\": \"<string>\"\n }\n ],\n \"computerDelegateAccountId\": 123,\n \"heartbeatInstructions\": \"<string>\",\n \"heartbeatEvery\": \"<string>\",\n \"heartbeatConfig\": {\n \"model\": \"<string>\",\n \"session\": \"<string>\",\n \"target\": \"<string>\",\n \"to\": \"<string>\",\n \"accountId\": \"<string>\",\n \"includeReasoning\": true,\n \"includeSystemPromptSection\": true,\n \"ackMaxChars\": 1,\n \"suppressToolErrorWarnings\": true,\n \"timeoutSeconds\": 2,\n \"lightContext\": true,\n \"isolatedSession\": true,\n \"skipWhenBusy\": true\n },\n \"backgroundAudio\": \"<string>\",\n \"waitOnAnswer\": 1,\n \"waitToGreet\": true,\n \"postAnswerDtmf\": \"<string>\",\n \"interruptionWordCount\": 1,\n \"interruptionMinimumSpeakingTime\": 1,\n \"speakingTimeout\": 1,\n \"speechProcessingDelay\": 1,\n \"speechProcessingDelayInterruptionStep\": 1,\n \"speechProcessingDelayMaxMultiplier\": 1,\n \"callerResponseTimeout\": 1,\n \"callerResponseTimeoutHangupCounter\": 1,\n \"ignoreSpeech\": [\n \"<string>\"\n ],\n \"noContactInjection\": true,\n \"noConvoHistory\": true,\n \"recordingNotificationPhrase\": \"<string>\",\n \"preAnswerRingTime\": 30,\n \"preAnswerSkipProcessingResults\": true,\n \"useAgentNumberForTransfers\": true,\n \"confirmTransfers\": true,\n \"monitorTransfers\": true,\n \"attendedTransfers\": true,\n \"attendedTransferBridgeTrigger\": \"<string>\",\n \"attendedTransferCheckInTimeout\": 1,\n \"transferConfirmTimeout\": 1,\n \"announceTransferConnecting\": true,\n \"announceTransferConnected\": true,\n \"preTransferNotificationStart\": \"<string>\",\n \"preTransferNotificationEnd\": \"<string>\",\n \"enableRingback\": true,\n \"enableTransferRingback\": true,\n \"cnamAutoRejectRegex\": \"<string>\",\n \"cnamAutoRejectCode\": 123,\n \"cnamAutoTransferRegex\": \"<string>\",\n \"cnamAutoTransferDestination\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Campaign updated successfully"
}Authorizations
Vida API Token
Query Parameters
Account whose staging configuration should be updated.
Body
application/json
Writable staging configuration. Omitted fields retain their current values.
Display name for the agent.
Short description of the agent.
Brand name the agent represents.
Primary instructions for voice, messaging, and Computer Agent work.
Greeting used at the beginning of a conversation. Prefix with prompt: to generate the greeting from instructions.
Web pages supplied as agent knowledge.
Searchable labels for the agent.
Model identifier returned by GET /api/v2/models/supported.
Reasoning budget for supported models; null disables it.
Available options:
low Model used by Pause & Think and optional post-conversation reasoning.
Use the thinking model for post-conversation work when the primary model is not reasoning-enabled.
IANA timezone used for scheduling and time-sensitive instructions.
Example:
"America/Chicago"
Exact voice ID returned by GET /api/v2/agent/voices.
Text-to-speech engine used when speech-to-speech mode is disabled.
Primary spoken language. Use multi only with a compatible voice and speech mode.
Available options:
en-US, multi, es-MX, es-ES, es-US Speech-to-speech engine; null uses separate speech recognition and synthesis.
Available options:
openai, gemini Speech recognition engine used when speech-to-speech mode is disabled.
Available options:
google, deepgram, deepgramflux, openai Apply smart formatting when supported by the selected speech recognition engine.
Functions enabled for this agent.
Show child attributes
Show child attributes
Agent-level structured fields collected after a conversation.
Show child attributes
Show child attributes
Installed apps assigned to this agent.
Show child attributes
Show child attributes
Computer Agent skills assigned at publish time.
Show child attributes
Show child attributes
Account ID of the Computer Agent that performs delegated Computer work.
Work the Computer Agent should perform during scheduled check-ins.
Heartbeat interval such as 15m, 1h, or 1h30m.
Advanced Computer Agent heartbeat settings. This object replaces the previous advanced settings when supplied, so preserve fields you do not intend to remove.
Show child attributes
Show child attributes
Optional HTTP(S) audio played during calls.
Milliseconds to wait before speaking the greeting.
Required range:
x >= 0Wait for the caller to speak before delivering the greeting.
DTMF digits sent immediately after an outbound call is answered.
Words required before caller speech interrupts the agent.
Required range:
x >= 0Seconds the agent must speak before interruption is allowed.
Required range:
x >= 0Milliseconds of silence used to detect the end of caller speech.
Required range:
x >= 0Milliseconds to wait before sending recognized speech to the model.
Required range:
x >= 0Milliseconds added to speech processing delay after an interruption.
Required range:
x >= 0Maximum interruption multiplier applied to speech processing delay.
Required range:
x >= 0Seconds of caller silence before the agent checks in.
Required range:
x >= 0Unanswered check-ins before the agent ends the call.
Required range:
x >= 0Caller phrases that should not be treated as a response.
Exclude the caller contact record from agent context.
Exclude prior conversation summaries from agent context.
Recording notice policy: jurisdiction-based, never, or every call.
Available options:
true, false, always Phrase spoken when a recording notice is required.
Seconds to ring before answering an inbound call.
Required range:
0 <= x <= 60Place raw Pre Answer results directly into context without an additional model pass.
Use the agent phone number as caller ID for transfers.
Require the recipient to confirm before completing a transfer.
Continue monitoring the call after a transfer.
Keep the agent with the caller while the recipient is reached.
Recipient response required to bridge an attended transfer.
Seconds before the agent checks in during an attended transfer.
Required range:
x >= 0Seconds to wait for transfer confirmation.
Required range:
x >= 0Announce that a transfer is being connected.
Announce when a transfer has connected.
Message spoken when Pre Transfer work begins.
Message spoken when Pre Transfer work completes.
Play ringback while the agent is connecting an outbound call.
Play ringback while a transfer is connecting.
Pattern used to reject matching inbound caller names before answer.
SIP response code used when the reject pattern matches.
Pattern used to transfer matching inbound caller names before answer.
Phone number, extension, or PBX destination used by automatic transfer.
⌘I