Update an agent

PUT

agent

{id}

Update an agent

curl --request PUT \
  --url https://api.vocobase.com/api/v2/agent/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_name": "<string>",
  "prompt": "<string>",
  "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "intro_message": "<string>",
  "voicemail_detection_enabled": true,
  "screener_handling_enabled": true,
  "voicemail_message": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enable_recording": true,
  "kb_include_summaries": true,
  "kb_result_format": "<string>",
  "kb_enable_llm_processing": true,
  "kb_llm_system_prompt": "<string>",
  "variables": [
    "<string>"
  ],
  "extraction_config": {
    "prompt": "<string>",
    "keys": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "includeToolLogs": false
  },
  "tool_ack_config": {
    "enabled": true,
    "maxWords": 100
  },
  "extraction_enabled": true,
  "end_call_enabled": true,
  "end_call_message": "<string>",
  "end_call_instructions": "<string>",
  "transfer_enabled": true,
  "transfer_number": "<string>",
  "transfer_message": "<string>",
  "transfer_instructions": "<string>",
  "user_idle_enabled": true,
  "max_call_duration_secs": 1830,
  "background_audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "background_audio_volume": 0.5
}
'

import requests

url = "https://api.vocobase.com/api/v2/agent/{id}"

payload = {
    "agent_name": "<string>",
    "prompt": "<string>",
    "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "intro_message": "<string>",
    "voicemail_detection_enabled": True,
    "screener_handling_enabled": True,
    "voicemail_message": "<string>",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enable_recording": True,
    "kb_include_summaries": True,
    "kb_result_format": "<string>",
    "kb_enable_llm_processing": True,
    "kb_llm_system_prompt": "<string>",
    "variables": ["<string>"],
    "extraction_config": {
        "prompt": "<string>",
        "keys": [
            {
                "name": "<string>",
                "description": "<string>"
            }
        ],
        "includeToolLogs": False
    },
    "tool_ack_config": {
        "enabled": True,
        "maxWords": 100
    },
    "extraction_enabled": True,
    "end_call_enabled": True,
    "end_call_message": "<string>",
    "end_call_instructions": "<string>",
    "transfer_enabled": True,
    "transfer_number": "<string>",
    "transfer_message": "<string>",
    "transfer_instructions": "<string>",
    "user_idle_enabled": True,
    "max_call_duration_secs": 1830,
    "background_audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "background_audio_volume": 0.5
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_name: '<string>',
    prompt: '<string>',
    voice_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    intro_message: '<string>',
    voicemail_detection_enabled: true,
    screener_handling_enabled: true,
    voicemail_message: '<string>',
    project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    enable_recording: true,
    kb_include_summaries: true,
    kb_result_format: '<string>',
    kb_enable_llm_processing: true,
    kb_llm_system_prompt: '<string>',
    variables: ['<string>'],
    extraction_config: {
      prompt: '<string>',
      keys: [{name: '<string>', description: '<string>'}],
      includeToolLogs: false
    },
    tool_ack_config: {enabled: true, maxWords: 100},
    extraction_enabled: true,
    end_call_enabled: true,
    end_call_message: '<string>',
    end_call_instructions: '<string>',
    transfer_enabled: true,
    transfer_number: '<string>',
    transfer_message: '<string>',
    transfer_instructions: '<string>',
    user_idle_enabled: true,
    max_call_duration_secs: 1830,
    background_audio_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    background_audio_volume: 0.5
  })
};

fetch('https://api.vocobase.com/api/v2/agent/{id}', 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.vocobase.com/api/v2/agent/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'agent_name' => '<string>',
    'prompt' => '<string>',
    'voice_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'intro_message' => '<string>',
    'voicemail_detection_enabled' => true,
    'screener_handling_enabled' => true,
    'voicemail_message' => '<string>',
    'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'enable_recording' => true,
    'kb_include_summaries' => true,
    'kb_result_format' => '<string>',
    'kb_enable_llm_processing' => true,
    'kb_llm_system_prompt' => '<string>',
    'variables' => [
        '<string>'
    ],
    'extraction_config' => [
        'prompt' => '<string>',
        'keys' => [
                [
                                'name' => '<string>',
                                'description' => '<string>'
                ]
        ],
        'includeToolLogs' => false
    ],
    'tool_ack_config' => [
        'enabled' => true,
        'maxWords' => 100
    ],
    'extraction_enabled' => true,
    'end_call_enabled' => true,
    'end_call_message' => '<string>',
    'end_call_instructions' => '<string>',
    'transfer_enabled' => true,
    'transfer_number' => '<string>',
    'transfer_message' => '<string>',
    'transfer_instructions' => '<string>',
    'user_idle_enabled' => true,
    'max_call_duration_secs' => 1830,
    'background_audio_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'background_audio_volume' => 0.5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.vocobase.com/api/v2/agent/{id}"

	payload := strings.NewReader("{\n  \"agent_name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": true,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": true,\n  \"kb_include_summaries\": true,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": true,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"variables\": [\n    \"<string>\"\n  ],\n  \"extraction_config\": {\n    \"prompt\": \"<string>\",\n    \"keys\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"includeToolLogs\": false\n  },\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": true,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"max_call_duration_secs\": 1830,\n  \"background_audio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"background_audio_volume\": 0.5\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.vocobase.com/api/v2/agent/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": true,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": true,\n  \"kb_include_summaries\": true,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": true,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"variables\": [\n    \"<string>\"\n  ],\n  \"extraction_config\": {\n    \"prompt\": \"<string>\",\n    \"keys\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"includeToolLogs\": false\n  },\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": true,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"max_call_duration_secs\": 1830,\n  \"background_audio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"background_audio_volume\": 0.5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocobase.com/api/v2/agent/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": true,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": true,\n  \"kb_include_summaries\": true,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": true,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"variables\": [\n    \"<string>\"\n  ],\n  \"extraction_config\": {\n    \"prompt\": \"<string>\",\n    \"keys\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"includeToolLogs\": false\n  },\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": true,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"max_call_duration_secs\": 1830,\n  \"background_audio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"background_audio_volume\": 0.5\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_name": "<string>",
    "prompt": "<string>",
    "voice_id": "<string>",
    "language": "<string>",
    "intro_message": "<string>",
    "voicemail_detection_enabled": true,
    "screener_handling_enabled": true,
    "voicemail_message": "<string>",
    "enable_recording": true,
    "kb_include_summaries": true,
    "kb_result_format": "<string>",
    "kb_enable_llm_processing": true,
    "kb_llm_system_prompt": "<string>",
    "variables": [
      "<string>"
    ],
    "extraction_config": {
      "prompt": "<string>",
      "keys": [
        {
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "includeToolLogs": false
    },
    "tool_ack_config": {
      "enabled": true,
      "maxWords": 100
    },
    "extraction_enabled": true,
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transfer_enabled": true,
    "transfer_number": "<string>",
    "transfer_message": "<string>",
    "transfer_instructions": "<string>",
    "end_call_enabled": true,
    "end_call_message": "<string>",
    "end_call_instructions": "<string>",
    "user_idle_enabled": true,
    "max_call_duration_secs": 600,
    "background_audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "background_audio_volume": 0.5,
    "document_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "agent_name is required and must be max 50 characters"
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

{
  "success": false,
  "error": {
    "code": "CONFLICT",
    "message": "An agent with this name already exists"
  }
}

{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred"
  }
}

Authorizations

Authorization

string

header

required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Path Parameters

string<uuid>

required

Agent ID.

Body

application/json

agent_name

string

New agent name.

Maximum string length: 50

prompt

string

New system prompt.

Maximum string length: 120000

voice_id

string<uuid>

New voice ID from the catalog returned by GET /agent/voices. Updates language and gender to match the selected voice.

agent_type

enum<string>

Available options:

inbound,

outbound

intro_message

string | null

New greeting message. Pass null or empty string to remove.

Maximum string length: 500

voicemail_detection_enabled

boolean

Toggle carrier-side voicemail detection for this agent on supported outbound providers.

screener_handling_enabled

boolean

Toggle phone screener handling for this agent on outbound calls. Requires voicemail_detection_enabled to be true and platform screener handling to be enabled.

voicemail_message

string | null

Update the message used after a supported carrier detects voicemail. Pass null or an empty string to clear.

Maximum string length: 500

project_id

string<uuid> | null

Move the agent to a different project.

enable_recording

boolean

kb_threshold

enum<string> | null

Pass null to reset to default (medium).

Available options:

low,

medium,

high,

null

kb_include_summaries

boolean

kb_result_format

string | null

Maximum string length: 2000

kb_enable_llm_processing

boolean

kb_llm_system_prompt

string | null

Maximum string length: 120000

variables

string[] | null

List of pre-call variable names referenced in the prompt or greeting as {{name}}. Per-call values are supplied via the variables body field on POST /calls/start. Pass null to clear.

Maximum array length: 100

Pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$

extraction_config

null | object

Custom Analysis config — runs an LLM extraction over the transcript after every completed call. Pass null to remove the config entirely. To pause extraction while keeping the config, use extraction_enabled: false instead.

Show child attributes

tool_ack_config

null | object

Per-agent spoken acknowledgement while a tool call runs. Omit to leave the current setting unchanged; pass null to disable, or an object to update. No default is applied on update (unlike create).

Show child attributes

extraction_enabled

boolean

Master switch for AUTOMATIC post-call extraction. Defaults to true. When false, extraction is skipped after calls even if extraction_config is set — the config is preserved, not deleted. Manual replay (POST /calls/{call_id}/extract) ignores this flag and runs as long as a config exists.

end_call_enabled

boolean

Toggle the agent's ability to end the call autonomously.

end_call_message

string | null

New farewell line. Pass null or empty string to fall back to the platform default.

Maximum string length: 500

end_call_instructions

string | null

Replace the free-text end-call instructions. Pass null or empty string to clear the section (the agent can still end calls via prompt logic if end_call_enabled is true). Replaces the prior end_call_triggers enum array.

Maximum string length: 2000

transfer_enabled

boolean

Toggle cold transfer. When false, transfer settings are cleared.

transfer_number

string | null

E.164 destination number. Required when transfer_enabled is true.

transfer_message

string | null

New announcement spoken before transferring. Pass null or empty string for the platform default.

Maximum string length: 500

transfer_instructions

string | null

Replace the free-text transfer instructions. Pass null or empty string to clear the section. Replaces the prior transfer_triggers enum array.

Maximum string length: 2000

user_idle_enabled

boolean

Toggle caller-silence follow-up for this agent. Defaults to true on new agents. Set false to prevent the bot from asking if the caller is still there or ending the call due to idle silence. Timeout and retry values remain platform-managed.

max_call_duration_secs

integer | null

Update the hard call-duration cap. Range 60-3600. Pass null to remove the cap. New agents default to 600 (10 minutes); existing agents created before the default landed may currently hold null.

Required range: 60 <= x <= 3600

background_audio_id

string<uuid> | null

Set or change the background-audio asset. Pass null to remove background audio.

background_audio_volume

number | null

Mixing volume override for background_audio_id. Range 0.0-1.0. Pass null to use the default (0.3).

Required range: 0 <= x <= 1

Response

Agent updated.

success

boolean

data

object

Show child attributes

Delete an agentSoft-deletes an agent and removes all linked document associations. Related knowledge-base cleanup is handled asynchronously.

Update an agent

curl --request PUT \
  --url https://api.vocobase.com/api/v2/agent/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_name": "<string>",
  "prompt": "<string>",
  "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "intro_message": "<string>",
  "voicemail_detection_enabled": true,
  "screener_handling_enabled": true,
  "voicemail_message": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enable_recording": true,
  "kb_include_summaries": true,
  "kb_result_format": "<string>",
  "kb_enable_llm_processing": true,
  "kb_llm_system_prompt": "<string>",
  "variables": [
    "<string>"
  ],
  "extraction_config": {
    "prompt": "<string>",
    "keys": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "includeToolLogs": false
  },
  "tool_ack_config": {
    "enabled": true,
    "maxWords": 100
  },
  "extraction_enabled": true,
  "end_call_enabled": true,
  "end_call_message": "<string>",
  "end_call_instructions": "<string>",
  "transfer_enabled": true,
  "transfer_number": "<string>",
  "transfer_message": "<string>",
  "transfer_instructions": "<string>",
  "user_idle_enabled": true,
  "max_call_duration_secs": 1830,
  "background_audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "background_audio_volume": 0.5
}
'

import requests

url = "https://api.vocobase.com/api/v2/agent/{id}"

payload = {
    "agent_name": "<string>",
    "prompt": "<string>",
    "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "intro_message": "<string>",
    "voicemail_detection_enabled": True,
    "screener_handling_enabled": True,
    "voicemail_message": "<string>",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enable_recording": True,
    "kb_include_summaries": True,
    "kb_result_format": "<string>",
    "kb_enable_llm_processing": True,
    "kb_llm_system_prompt": "<string>",
    "variables": ["<string>"],
    "extraction_config": {
        "prompt": "<string>",
        "keys": [
            {
                "name": "<string>",
                "description": "<string>"
            }
        ],
        "includeToolLogs": False
    },
    "tool_ack_config": {
        "enabled": True,
        "maxWords": 100
    },
    "extraction_enabled": True,
    "end_call_enabled": True,
    "end_call_message": "<string>",
    "end_call_instructions": "<string>",
    "transfer_enabled": True,
    "transfer_number": "<string>",
    "transfer_message": "<string>",
    "transfer_instructions": "<string>",
    "user_idle_enabled": True,
    "max_call_duration_secs": 1830,
    "background_audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "background_audio_volume": 0.5
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_name: '<string>',
    prompt: '<string>',
    voice_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    intro_message: '<string>',
    voicemail_detection_enabled: true,
    screener_handling_enabled: true,
    voicemail_message: '<string>',
    project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    enable_recording: true,
    kb_include_summaries: true,
    kb_result_format: '<string>',
    kb_enable_llm_processing: true,
    kb_llm_system_prompt: '<string>',
    variables: ['<string>'],
    extraction_config: {
      prompt: '<string>',
      keys: [{name: '<string>', description: '<string>'}],
      includeToolLogs: false
    },
    tool_ack_config: {enabled: true, maxWords: 100},
    extraction_enabled: true,
    end_call_enabled: true,
    end_call_message: '<string>',
    end_call_instructions: '<string>',
    transfer_enabled: true,
    transfer_number: '<string>',
    transfer_message: '<string>',
    transfer_instructions: '<string>',
    user_idle_enabled: true,
    max_call_duration_secs: 1830,
    background_audio_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    background_audio_volume: 0.5
  })
};

fetch('https://api.vocobase.com/api/v2/agent/{id}', 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.vocobase.com/api/v2/agent/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'agent_name' => '<string>',
    'prompt' => '<string>',
    'voice_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'intro_message' => '<string>',
    'voicemail_detection_enabled' => true,
    'screener_handling_enabled' => true,
    'voicemail_message' => '<string>',
    'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'enable_recording' => true,
    'kb_include_summaries' => true,
    'kb_result_format' => '<string>',
    'kb_enable_llm_processing' => true,
    'kb_llm_system_prompt' => '<string>',
    'variables' => [
        '<string>'
    ],
    'extraction_config' => [
        'prompt' => '<string>',
        'keys' => [
                [
                                'name' => '<string>',
                                'description' => '<string>'
                ]
        ],
        'includeToolLogs' => false
    ],
    'tool_ack_config' => [
        'enabled' => true,
        'maxWords' => 100
    ],
    'extraction_enabled' => true,
    'end_call_enabled' => true,
    'end_call_message' => '<string>',
    'end_call_instructions' => '<string>',
    'transfer_enabled' => true,
    'transfer_number' => '<string>',
    'transfer_message' => '<string>',
    'transfer_instructions' => '<string>',
    'user_idle_enabled' => true,
    'max_call_duration_secs' => 1830,
    'background_audio_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'background_audio_volume' => 0.5
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.vocobase.com/api/v2/agent/{id}"

	payload := strings.NewReader("{\n  \"agent_name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": true,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": true,\n  \"kb_include_summaries\": true,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": true,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"variables\": [\n    \"<string>\"\n  ],\n  \"extraction_config\": {\n    \"prompt\": \"<string>\",\n    \"keys\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"includeToolLogs\": false\n  },\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": true,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"max_call_duration_secs\": 1830,\n  \"background_audio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"background_audio_volume\": 0.5\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.vocobase.com/api/v2/agent/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": true,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": true,\n  \"kb_include_summaries\": true,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": true,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"variables\": [\n    \"<string>\"\n  ],\n  \"extraction_config\": {\n    \"prompt\": \"<string>\",\n    \"keys\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"includeToolLogs\": false\n  },\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": true,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"max_call_duration_secs\": 1830,\n  \"background_audio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"background_audio_volume\": 0.5\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocobase.com/api/v2/agent/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": true,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": true,\n  \"kb_include_summaries\": true,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": true,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"variables\": [\n    \"<string>\"\n  ],\n  \"extraction_config\": {\n    \"prompt\": \"<string>\",\n    \"keys\": [\n      {\n        \"name\": \"<string>\",\n        \"description\": \"<string>\"\n      }\n    ],\n    \"includeToolLogs\": false\n  },\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": true,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"max_call_duration_secs\": 1830,\n  \"background_audio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"background_audio_volume\": 0.5\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_name": "<string>",
    "prompt": "<string>",
    "voice_id": "<string>",
    "language": "<string>",
    "intro_message": "<string>",
    "voicemail_detection_enabled": true,
    "screener_handling_enabled": true,
    "voicemail_message": "<string>",
    "enable_recording": true,
    "kb_include_summaries": true,
    "kb_result_format": "<string>",
    "kb_enable_llm_processing": true,
    "kb_llm_system_prompt": "<string>",
    "variables": [
      "<string>"
    ],
    "extraction_config": {
      "prompt": "<string>",
      "keys": [
        {
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "includeToolLogs": false
    },
    "tool_ack_config": {
      "enabled": true,
      "maxWords": 100
    },
    "extraction_enabled": true,
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transfer_enabled": true,
    "transfer_number": "<string>",
    "transfer_message": "<string>",
    "transfer_instructions": "<string>",
    "end_call_enabled": true,
    "end_call_message": "<string>",
    "end_call_instructions": "<string>",
    "user_idle_enabled": true,
    "max_call_duration_secs": 600,
    "background_audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "background_audio_volume": 0.5,
    "document_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "agent_name is required and must be max 50 characters"
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found"
  }
}

{
  "success": false,
  "error": {
    "code": "CONFLICT",
    "message": "An agent with this name already exists"
  }
}

{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred"
  }
}

Getting Started

Guides

Partner Onboarding

API Reference

Webhooks

Telephony

Authorizations

Path Parameters

Body

Response