PATCH

Update Agent

Updates one or more fields on an existing Agent.

PATCHhttps://api.vantaxai.com/v1/agents/{agent_id}

Only include the fields you want to change. Assigning a `knowledgebase_id` or `calendar_id` here is how you wire those resources to an Agent.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…
Content-Typestringrequired
Must be application/json for requests with a body.
example: application/json

Path Parameters

agent_idstringrequired
The Agent to update.
example: agt_3d9b21

Body Parameters

namestringoptional
New display name.
system_promptstringoptional
Updated instructions / persona.
voice_idstringoptional
Reassign the voice.
knowledgebase_idstringoptional
Attach (or replace) the knowledge base.
calendar_idstringoptional
Attach (or replace) the booking calendar.
ai_modelstringoptional
Switch the underlying model.
is_activebooleanoptional
Enable or disable the Agent.

Request

curl -X PATCH https://api.vantaxai.com/v1/agents/agt_3d9b21 \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "system_prompt": "string",
  "voice_id": "string",
  "knowledgebase_id": "string"
}'

const res = await fetch(
  "https://api.vantaxai.com/v1/agents/agt_3d9b21",
  {
  method: "PATCH",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "system_prompt": "string",
    "voice_id": "string",
    "knowledgebase_id": "string"
  }),
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// PATCH /v1/agents/{agent_id}
const result = await vantax.request("PATCH", "/v1/agents/{agent_id}", {
  "name": "string",
  "system_prompt": "string",
  "voice_id": "string",
  "knowledgebase_id": "string"
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# PATCH /v1/agents/{agent_id}
result = vantax.request("PATCH", "/v1/agents/{agent_id}", json={"name": "string", "system_prompt": "string", "voice_id": "string", "knowledgebase_id": "string"})

Response

{
  "success": true,
  "message": "Agent updated successfully",
  "data": {
    "id": "agt_3d9b21",
    "name": "Front Desk Agent (After Hours)",
    "is_active": false,
    "updated_at": "2026-02-02T08:12:00Z"
  }
}

{ "success": false, "message": "Agent not found" }