Create an agent

POST

agent

Create an agent

curl --request POST \
  --url https://api.vocobase.com/api/v2/agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_name": "Sales Assistant",
  "prompt": "<string>",
  "voice_id": "b49e0d0f-2219-4425-a765-1efd32beb509",
  "intro_message": "<string>",
  "voicemail_detection_enabled": true,
  "screener_handling_enabled": false,
  "voicemail_message": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enable_recording": false,
  "kb_threshold": "medium",
  "kb_include_summaries": false,
  "kb_result_format": "<string>",
  "kb_enable_llm_processing": false,
  "kb_llm_system_prompt": "<string>",
  "end_call_enabled": true,
  "end_call_message": "<string>",
  "end_call_instructions": "<string>",
  "transfer_enabled": false,
  "transfer_number": "<string>",
  "transfer_message": "<string>",
  "transfer_instructions": "<string>",
  "user_idle_enabled": true,
  "tool_ack_config": {
    "enabled": true,
    "maxWords": 100
  },
  "extraction_enabled": true,
  "max_call_duration_secs": 600,
  "background_audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "background_audio_volume": 0.5
}
'

import requests

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

payload = {
    "agent_name": "Sales Assistant",
    "prompt": "<string>",
    "voice_id": "b49e0d0f-2219-4425-a765-1efd32beb509",
    "intro_message": "<string>",
    "voicemail_detection_enabled": True,
    "screener_handling_enabled": False,
    "voicemail_message": "<string>",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enable_recording": False,
    "kb_threshold": "medium",
    "kb_include_summaries": False,
    "kb_result_format": "<string>",
    "kb_enable_llm_processing": False,
    "kb_llm_system_prompt": "<string>",
    "end_call_enabled": True,
    "end_call_message": "<string>",
    "end_call_instructions": "<string>",
    "transfer_enabled": False,
    "transfer_number": "<string>",
    "transfer_message": "<string>",
    "transfer_instructions": "<string>",
    "user_idle_enabled": True,
    "tool_ack_config": {
        "enabled": True,
        "maxWords": 100
    },
    "extraction_enabled": True,
    "max_call_duration_secs": 600,
    "background_audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "background_audio_volume": 0.5
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_name: 'Sales Assistant',
    prompt: '<string>',
    voice_id: 'b49e0d0f-2219-4425-a765-1efd32beb509',
    intro_message: '<string>',
    voicemail_detection_enabled: true,
    screener_handling_enabled: false,
    voicemail_message: '<string>',
    project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    enable_recording: false,
    kb_threshold: 'medium',
    kb_include_summaries: false,
    kb_result_format: '<string>',
    kb_enable_llm_processing: false,
    kb_llm_system_prompt: '<string>',
    end_call_enabled: true,
    end_call_message: '<string>',
    end_call_instructions: '<string>',
    transfer_enabled: false,
    transfer_number: '<string>',
    transfer_message: '<string>',
    transfer_instructions: '<string>',
    user_idle_enabled: true,
    tool_ack_config: {enabled: true, maxWords: 100},
    extraction_enabled: true,
    max_call_duration_secs: 600,
    background_audio_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    background_audio_volume: 0.5
  })
};

fetch('https://api.vocobase.com/api/v2/agent', 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",
  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([
    'agent_name' => 'Sales Assistant',
    'prompt' => '<string>',
    'voice_id' => 'b49e0d0f-2219-4425-a765-1efd32beb509',
    'intro_message' => '<string>',
    'voicemail_detection_enabled' => true,
    'screener_handling_enabled' => false,
    'voicemail_message' => '<string>',
    'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'enable_recording' => false,
    'kb_threshold' => 'medium',
    'kb_include_summaries' => false,
    'kb_result_format' => '<string>',
    'kb_enable_llm_processing' => false,
    'kb_llm_system_prompt' => '<string>',
    'end_call_enabled' => true,
    'end_call_message' => '<string>',
    'end_call_instructions' => '<string>',
    'transfer_enabled' => false,
    'transfer_number' => '<string>',
    'transfer_message' => '<string>',
    'transfer_instructions' => '<string>',
    'user_idle_enabled' => true,
    'tool_ack_config' => [
        'enabled' => true,
        'maxWords' => 100
    ],
    'extraction_enabled' => true,
    'max_call_duration_secs' => 600,
    '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"

	payload := strings.NewReader("{\n  \"agent_name\": \"Sales Assistant\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"b49e0d0f-2219-4425-a765-1efd32beb509\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": false,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": false,\n  \"kb_threshold\": \"medium\",\n  \"kb_include_summaries\": false,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": false,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": false,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"max_call_duration_secs\": 600,\n  \"background_audio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"background_audio_volume\": 0.5\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.vocobase.com/api/v2/agent")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_name\": \"Sales Assistant\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"b49e0d0f-2219-4425-a765-1efd32beb509\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": false,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": false,\n  \"kb_threshold\": \"medium\",\n  \"kb_include_summaries\": false,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": false,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": false,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"max_call_duration_secs\": 600,\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")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_name\": \"Sales Assistant\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"b49e0d0f-2219-4425-a765-1efd32beb509\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": false,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": false,\n  \"kb_threshold\": \"medium\",\n  \"kb_include_summaries\": false,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": false,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": false,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"max_call_duration_secs\": 600,\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": "LIMIT_REACHED",
    "message": "Agent limit reached. Maximum 10 agents allowed."
  }
}

{
  "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.

Body

application/json

agent_name

string

required

Unique agent name.

Maximum string length: 50

Example:

"Sales Assistant"

prompt

string

required

System prompt defining the agent's personality and behavior.

Maximum string length: 120000

voice_id

string<uuid>

required

Voice ID from the catalog returned by GET /agent/voices. The language and gender are taken from the selected voice.

Example:

"b49e0d0f-2219-4425-a765-1efd32beb509"

agent_type

enum<string>

required

Whether the agent handles inbound or outbound calls.

Available options:

inbound,

outbound

intro_message

string | null

Optional greeting spoken when a call connects.

Maximum string length: 500

voicemail_detection_enabled

boolean

default:true

Per-agent toggle for carrier-side voicemail detection on supported outbound providers. Account-level provider support must also be enabled.

screener_handling_enabled

boolean

default:false

Per-agent toggle for phone screener handling on outbound calls. Requires voicemail_detection_enabled to be true and platform screener handling to be enabled.

voicemail_message

string | null

Optional 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

Assign the agent to a specific project. Defaults to the default project if omitted.

enable_recording

boolean

default:false

Whether to record calls made with this agent.

kb_threshold

enum<string> | null

default:medium

Knowledge base search relevance threshold.

Available options:

low,

medium,

high,

null

kb_include_summaries

boolean

default:false

Include document summaries in KB search results.

kb_result_format

string | null

Custom format template for KB search results.

Maximum string length: 2000

kb_enable_llm_processing

boolean

default:false

Enable LLM post-processing of KB search results.

kb_llm_system_prompt

string | null

System prompt for LLM KB processing.

Maximum string length: 120000

end_call_enabled

boolean

default:true

Master toggle for the end-call tool. When false, the agent cannot end calls on its own regardless of end_call_instructions.

end_call_message

string | null

Farewell line spoken before the bot hangs up. When null/empty, a platform default is used.

Maximum string length: 500

end_call_instructions

string | null

Free-text natural-language instructions spliced into the system prompt under "When to end the call." Write your own conditions in plain English, e.g. "End the call when the caller says goodbye, has not spoken for an extended period, or asks to be removed from the list." When null/empty, the section is skipped entirely. Replaces the prior end_call_triggers enum array.

Maximum string length: 2000

transfer_enabled

boolean

default:false

Master toggle for cold-transfer-to-human. transfer_number is required when true. When the agent transfers a call, Vocobase connects the caller to transfer_number. The session.completed webhook includes transfer metadata — see data.call.transferred.

transfer_number

string | null

E.164 number to transfer the call to. Required when transfer_enabled is true.

transfer_message

string | null

Announcement spoken before the transfer. When null/empty, a platform default is used.

Maximum string length: 500

transfer_instructions

string | null

Free-text natural-language instructions spliced into the system prompt under "When to transfer." Write your own conditions in plain English. When null/empty, the section is skipped. Replaces the prior transfer_triggers enum array.

Maximum string length: 2000

user_idle_enabled

boolean

default:true

Controls whether the agent responds to caller silence using platform-managed idle settings. Defaults to true. When false, the bot will not ask if the caller is still there and will not end the call because of idle silence. Timeout and retry values are not configurable through V2.

tool_ack_config

null | object

Per-agent spoken acknowledgement while a tool call (e.g. search_knowledge_base) runs. New agents default to enabled with mode set to dynamic when this field is omitted. Pass null to opt the new agent out, or an object to customize.

Show child attributes

extraction_enabled

boolean

default:true

Master switch for automatic post-call extraction. Defaults to true. When false, extraction is skipped after calls even if an extraction_config is later set (the config is preserved). The extraction schema itself is set via PUT /agent/{id} (extraction_config).

max_call_duration_secs

integer | null

default:600

Hard cap on call duration in seconds. New agents default to 600 (10 minutes); pass null to disable the cap. Range 60-3600. At (cap - 30s) the bot speaks a soft "wrapping up" warning; at the cap it speaks the agent's farewell and gracefully ends the session through the standard end-of-call path.

Required range: 60 <= x <= 3600

background_audio_id

string<uuid> | null

Reference to a BackgroundAudio asset (see GET /agent/background-audio) the bot will mix under its TTS for the duration of the call.

background_audio_volume

number | null

Mixing volume for background_audio_id. Range 0.0-1.0. When null, the bot applies a default of 0.3.

Required range: 0 <= x <= 1

Response

Agent created successfully.

success

boolean

data

object

Show child attributes

Get an agentReturns a single agent by ID.

Create an agent

curl --request POST \
  --url https://api.vocobase.com/api/v2/agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_name": "Sales Assistant",
  "prompt": "<string>",
  "voice_id": "b49e0d0f-2219-4425-a765-1efd32beb509",
  "intro_message": "<string>",
  "voicemail_detection_enabled": true,
  "screener_handling_enabled": false,
  "voicemail_message": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enable_recording": false,
  "kb_threshold": "medium",
  "kb_include_summaries": false,
  "kb_result_format": "<string>",
  "kb_enable_llm_processing": false,
  "kb_llm_system_prompt": "<string>",
  "end_call_enabled": true,
  "end_call_message": "<string>",
  "end_call_instructions": "<string>",
  "transfer_enabled": false,
  "transfer_number": "<string>",
  "transfer_message": "<string>",
  "transfer_instructions": "<string>",
  "user_idle_enabled": true,
  "tool_ack_config": {
    "enabled": true,
    "maxWords": 100
  },
  "extraction_enabled": true,
  "max_call_duration_secs": 600,
  "background_audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "background_audio_volume": 0.5
}
'

import requests

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

payload = {
    "agent_name": "Sales Assistant",
    "prompt": "<string>",
    "voice_id": "b49e0d0f-2219-4425-a765-1efd32beb509",
    "intro_message": "<string>",
    "voicemail_detection_enabled": True,
    "screener_handling_enabled": False,
    "voicemail_message": "<string>",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enable_recording": False,
    "kb_threshold": "medium",
    "kb_include_summaries": False,
    "kb_result_format": "<string>",
    "kb_enable_llm_processing": False,
    "kb_llm_system_prompt": "<string>",
    "end_call_enabled": True,
    "end_call_message": "<string>",
    "end_call_instructions": "<string>",
    "transfer_enabled": False,
    "transfer_number": "<string>",
    "transfer_message": "<string>",
    "transfer_instructions": "<string>",
    "user_idle_enabled": True,
    "tool_ack_config": {
        "enabled": True,
        "maxWords": 100
    },
    "extraction_enabled": True,
    "max_call_duration_secs": 600,
    "background_audio_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "background_audio_volume": 0.5
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_name: 'Sales Assistant',
    prompt: '<string>',
    voice_id: 'b49e0d0f-2219-4425-a765-1efd32beb509',
    intro_message: '<string>',
    voicemail_detection_enabled: true,
    screener_handling_enabled: false,
    voicemail_message: '<string>',
    project_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    enable_recording: false,
    kb_threshold: 'medium',
    kb_include_summaries: false,
    kb_result_format: '<string>',
    kb_enable_llm_processing: false,
    kb_llm_system_prompt: '<string>',
    end_call_enabled: true,
    end_call_message: '<string>',
    end_call_instructions: '<string>',
    transfer_enabled: false,
    transfer_number: '<string>',
    transfer_message: '<string>',
    transfer_instructions: '<string>',
    user_idle_enabled: true,
    tool_ack_config: {enabled: true, maxWords: 100},
    extraction_enabled: true,
    max_call_duration_secs: 600,
    background_audio_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    background_audio_volume: 0.5
  })
};

fetch('https://api.vocobase.com/api/v2/agent', 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",
  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([
    'agent_name' => 'Sales Assistant',
    'prompt' => '<string>',
    'voice_id' => 'b49e0d0f-2219-4425-a765-1efd32beb509',
    'intro_message' => '<string>',
    'voicemail_detection_enabled' => true,
    'screener_handling_enabled' => false,
    'voicemail_message' => '<string>',
    'project_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'enable_recording' => false,
    'kb_threshold' => 'medium',
    'kb_include_summaries' => false,
    'kb_result_format' => '<string>',
    'kb_enable_llm_processing' => false,
    'kb_llm_system_prompt' => '<string>',
    'end_call_enabled' => true,
    'end_call_message' => '<string>',
    'end_call_instructions' => '<string>',
    'transfer_enabled' => false,
    'transfer_number' => '<string>',
    'transfer_message' => '<string>',
    'transfer_instructions' => '<string>',
    'user_idle_enabled' => true,
    'tool_ack_config' => [
        'enabled' => true,
        'maxWords' => 100
    ],
    'extraction_enabled' => true,
    'max_call_duration_secs' => 600,
    '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"

	payload := strings.NewReader("{\n  \"agent_name\": \"Sales Assistant\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"b49e0d0f-2219-4425-a765-1efd32beb509\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": false,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": false,\n  \"kb_threshold\": \"medium\",\n  \"kb_include_summaries\": false,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": false,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": false,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"max_call_duration_secs\": 600,\n  \"background_audio_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"background_audio_volume\": 0.5\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.vocobase.com/api/v2/agent")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_name\": \"Sales Assistant\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"b49e0d0f-2219-4425-a765-1efd32beb509\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": false,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": false,\n  \"kb_threshold\": \"medium\",\n  \"kb_include_summaries\": false,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": false,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": false,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"max_call_duration_secs\": 600,\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")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_name\": \"Sales Assistant\",\n  \"prompt\": \"<string>\",\n  \"voice_id\": \"b49e0d0f-2219-4425-a765-1efd32beb509\",\n  \"intro_message\": \"<string>\",\n  \"voicemail_detection_enabled\": true,\n  \"screener_handling_enabled\": false,\n  \"voicemail_message\": \"<string>\",\n  \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enable_recording\": false,\n  \"kb_threshold\": \"medium\",\n  \"kb_include_summaries\": false,\n  \"kb_result_format\": \"<string>\",\n  \"kb_enable_llm_processing\": false,\n  \"kb_llm_system_prompt\": \"<string>\",\n  \"end_call_enabled\": true,\n  \"end_call_message\": \"<string>\",\n  \"end_call_instructions\": \"<string>\",\n  \"transfer_enabled\": false,\n  \"transfer_number\": \"<string>\",\n  \"transfer_message\": \"<string>\",\n  \"transfer_instructions\": \"<string>\",\n  \"user_idle_enabled\": true,\n  \"tool_ack_config\": {\n    \"enabled\": true,\n    \"maxWords\": 100\n  },\n  \"extraction_enabled\": true,\n  \"max_call_duration_secs\": 600,\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": "LIMIT_REACHED",
    "message": "Agent limit reached. Maximum 10 agents allowed."
  }
}

{
  "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

Body

Response