Skip to main content
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": "<string>",
  "language": "<string>",
  "agent_type": "inbound",
  "intro_message": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enable_recording": true,
  "kb_threshold": "low",
  "kb_include_summaries": true,
  "kb_result_format": "<string>",
  "kb_enable_llm_processing": true,
  "kb_llm_system_prompt": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_name": "<string>",
    "prompt": "<string>",
    "voice_id": "<string>",
    "language": "<string>",
    "agent_type": "inbound",
    "intro_message": "<string>",
    "enable_recording": true,
    "kb_threshold": "low",
    "kb_include_summaries": true,
    "kb_result_format": "<string>",
    "kb_enable_llm_processing": true,
    "kb_llm_system_prompt": "<string>",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "document_count": 123,
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
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

New voice ID from allowed voices.

language
string

New language code from allowed languages.

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

Response

Agent updated.

success
boolean
data
object