Update Agent

PATCH

chat

agents

{id}

Update agent

curl --request PATCH \
  --url https://api.agntix.ai/v2/chat/agents/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fullName": "Tier-1 Support — Updated",
  "systemPrompt": "You specialize in billing, returns, and account access. Be brief.",
  "isActive": true
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fullName: 'Tier-1 Support — Updated',
    systemPrompt: 'You specialize in billing, returns, and account access. Be brief.',
    isActive: true
  })
};

fetch('https://api.agntix.ai/v2/chat/agents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.agntix.ai/v2/chat/agents/{id}"

payload = {
    "fullName": "Tier-1 Support — Updated",
    "systemPrompt": "You specialize in billing, returns, and account access. Be brief.",
    "isActive": True
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "fullName": "Customer Support Bot",
  "description": "Handles tier-1 customer queries",
  "role": "You are a helpful support agent for Acme Inc.",
  "language": "en",
  "systemPrompt": "<string>",
  "voiceEnabled": false,
  "voicePipelineMode": "<string>",
  "isActive": true,
  "isPublic": false,
  "orgId": "org_2abc123",
  "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2026-04-28T11:42:11Z",
  "updatedAt": "2026-04-28T11:42:11Z"
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "fullName should not be empty",
    "status": 400
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required.",
    "status": 401
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Agent not found.",
    "status": 404
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

Every endpoint on this page requires either a Clerk-issued JWT (Authorization: Bearer <token>) or an organization API key (x-api-key: pk_…). Anonymous calls return 401 Unauthorized. See Authentication for the full setup.

Tool attachments are replaced on update, not merged. To add a tool, send the full list of desired tools including existing ones. Pass "tools": [] to detach all tools.

Code examples

curl -X PATCH https://api.agntix.ai/v2/chat/agents/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "x-api-key: pk_live_••••" \
  -H "Content-Type: application/json" \
  -d '{
    "fullName": "Tier-1 Support — Updated",
    "systemPrompt": "You specialize in billing, returns, and account access. Be brief and friendly.",
    "isActive": true
  }'

const agentId = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';

const res = await fetch(`https://api.agntix.ai/v2/chat/agents/${agentId}`, {
  method: 'PATCH',
  headers: {
    'x-api-key': 'pk_live_••••',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    systemPrompt: 'You specialize in billing, returns, and account access. Be brief.',
    tools: [
      { toolId: '550e8400-e29b-41d4-a716-446655440000' },
      { toolId: '660e8400-e29b-41d4-a716-446655441111' },
    ],
  }),
});
const updated = await res.json();

import httpx

agent_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

updated = httpx.patch(
    f"https://api.agntix.ai/v2/chat/agents/{agent_id}",
    headers={"x-api-key": "pk_live_••••"},
    json={
        "fullName": "Tier-1 Support — Updated",
        "isActive": True,
    },
).json()

Updating tools

To attach a new tool without removing existing ones, first fetch the agent, then send the merged list:

Node.js

const agent = await fetch(`https://api.agntix.ai/v2/chat/agents/${id}`, {
  headers: { 'x-api-key': 'pk_live_••••' },
}).then(r => r.json());

const existingToolIds = agent.agentTools.map(({ tool }) => ({ toolId: tool.id }));

await fetch(`https://api.agntix.ai/v2/chat/agents/${id}`, {
  method: 'PATCH',
  headers: { 'x-api-key': 'pk_live_••••', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    tools: [...existingToolIds, { toolId: 'new-tool-uuid' }],
  }),
});

Sample response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "fullName": "Tier-1 Support — Updated",
  "systemPrompt": "You specialize in billing, returns, and account access. Be brief and friendly.",
  "isActive": true,
  "updatedAt": "2026-04-29T09:30:00Z"
}

Authorizations

x-api-key

string

header

required

Organization API key. Obtain from the dashboard. Format: pk_live_…

Path Parameters

string<uuid>

required

Body

application/json

All fields are optional — only provided fields are updated.

fullName

string

description

string

role

string

language

string

systemPrompt

string

specialInstructions

string

modelId

string<uuid>

voiceEnabled

boolean

voicePipelineMode

enum<string>

Available options:

pipeline,

sts,

hybrid

isActive

boolean

isPublic

boolean

tools

object[]

Show child attributes

subAgents

object[]

Pass [] to remove all sub-agents.

Response

Updated agent.

string<uuid>

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

fullName

string

Example:

"Customer Support Bot"

description

string

Example:

"Handles tier-1 customer queries"

role

string

Example:

"You are a helpful support agent for Acme Inc."

language

string

Example:

"en"

systemPrompt

string

voiceEnabled

boolean

Example:

false

voicePipelineMode

string | null

isActive

boolean

Example:

true

isPublic

boolean

Example:

false

orgId

string

Example:

"org_2abc123"

modelId

string<uuid>

createdAt

string<date-time>

Example:

"2026-04-28T11:42:11Z"

updatedAt

string<date-time>

Example:

"2026-04-28T11:42:11Z"

Update agent

curl --request PATCH \
  --url https://api.agntix.ai/v2/chat/agents/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fullName": "Tier-1 Support — Updated",
  "systemPrompt": "You specialize in billing, returns, and account access. Be brief.",
  "isActive": true
}
'

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fullName: 'Tier-1 Support — Updated',
    systemPrompt: 'You specialize in billing, returns, and account access. Be brief.',
    isActive: true
  })
};

fetch('https://api.agntix.ai/v2/chat/agents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.agntix.ai/v2/chat/agents/{id}"

payload = {
    "fullName": "Tier-1 Support — Updated",
    "systemPrompt": "You specialize in billing, returns, and account access. Be brief.",
    "isActive": True
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "fullName": "Customer Support Bot",
  "description": "Handles tier-1 customer queries",
  "role": "You are a helpful support agent for Acme Inc.",
  "language": "en",
  "systemPrompt": "<string>",
  "voiceEnabled": false,
  "voicePipelineMode": "<string>",
  "isActive": true,
  "isPublic": false,
  "orgId": "org_2abc123",
  "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2026-04-28T11:42:11Z",
  "updatedAt": "2026-04-28T11:42:11Z"
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "fullName should not be empty",
    "status": 400
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required.",
    "status": 401
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Agent not found.",
    "status": 404
  },
  "meta": {
    "requestId": "req_01j3m...",
    "timestamp": "2026-04-29T10:00:00Z"
  }
}

Overview

Agents

Chat

Voice

Tools

Phone Numbers

Code examples

Updating tools

Sample response

Authorizations

Path Parameters

Body

Response

​Code examples

​Updating tools

​Sample response

Authorizations

Path Parameters

Body

Response

Code examples

Updating tools

Sample response