Update an Agent
Updates the current Agent desired state under agents:write with last-write-wins fields and reconciles voice provider state before reporting success; a supplied profile, Knowledge selection, or tool access replaces that complete part and may require additional permissions. Tool access keeps its own optimistic revision. Confirm an uncertain response before retrying.
curl --request PATCH \
--url https://api.getarbol.com/v1/agents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"language": "<string>"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({language: '<string>'})
};
fetch('https://api.getarbol.com/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.getarbol.com/v1/agents/{id}"
payload = { "language": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"createdAt": "2026-08-29T14:30:00Z",
"description": "<string>",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"kind": "voice",
"language": "<string>",
"name": "Asistente de ventas",
"profile": {
"greeting": "<string>",
"channelKind": "voice",
"settings": {
"availableLanguages": [
"<string>"
],
"conversationalBehavior": {
"backgroundSound": {
"crossfadeLoop": true,
"presetId": "office1",
"volume": 0.6
},
"backgroundVoiceDetection": false,
"expressiveMode": false,
"interruptionIgnoreTerms": [],
"keywords": [],
"maxDurationMessage": "<string>",
"maxDurationSeconds": 600,
"mergeDefaultIgnoreTerms": false,
"retranscribeOnTurnTimeout": false,
"silenceEndCallTimeoutSeconds": 20,
"speculativeTurn": false,
"spellingPatience": "auto",
"transcribeOnDisabledInterruptions": false,
"turnEagerness": "normal",
"turnModel": "turn_v3",
"turnTimeoutSeconds": 7
},
"disableFirstMessageInterruptions": true,
"greetingTranslations": [
{
"language": "<string>",
"text": "<string>"
}
],
"humanTransfers": [
{
"condition": "<string>",
"phoneNumber": "+573001234567",
"transferType": "conference"
}
],
"intelligence": {
"backupLlm": {
"mode": "default",
"order": []
},
"cascadeTimeoutSeconds": 4,
"llm": "gpt-5.6-luna",
"maxTokens": -1,
"parallelToolCalls": false,
"reasoningEffort": "none",
"reasoningSummary": false,
"softTimeout": {
"enabled": false,
"message": "",
"seconds": 3
},
"temperature": 0.7
},
"toolConfigs": [
{
"config": {
"endCallDescription": "<string>",
"endCallReasons": [
"farewell"
]
},
"isEnabled": true,
"type": "END_CALL"
}
],
"voiceConfigs": [
{
"language": "<string>",
"settings": {
"similarity": 0.8,
"speed": 1,
"stability": 0.5
},
"voiceId": "<string>",
"label": "<string>"
}
]
}
},
"prompt": "<string>",
"status": "active",
"timezone": "America/Bogota",
"updatedAt": "2026-08-29T14:30:00Z",
"isRunnable": true,
"knowledgeDocumentIds": [
"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
],
"toolAccess": {
"entries": [
{
"connectedAccountId": "<string>",
"tools": [
{
"key": "google-calendar.create-event"
}
]
}
],
"revision": 4503599627370495
}
}{
"defined": true,
"inferable": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "<string>",
"data": {
"issues": [
{
"code": "custom",
"message": "<string>",
"path": [
"<string>"
]
}
],
"truncated": true
}
}{
"defined": true,
"inferable": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "FORBIDDEN",
"status": 403,
"message": "<string>",
"data": {
"missingPermissions": [
"agents:read"
]
}
}{
"defined": true,
"inferable": true,
"code": "NOT_FOUND",
"status": 404,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "CONFLICT",
"status": 409,
"message": "<string>",
"data": {
"currentRevision": 4503599627370495
}
}{
"code": "PAYLOAD_TOO_LARGE",
"defined": false,
"inferable": false,
"message": "<string>",
"data": "<unknown>"
}{
"code": "UNSUPPORTED_MEDIA_TYPE",
"defined": false,
"inferable": false,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "UNPROCESSABLE_CONTENT",
"status": 422,
"message": "<string>",
"data": {
"reason": "primary_voice_missing"
}
}{
"defined": true,
"inferable": true,
"code": "TOO_MANY_REQUESTS",
"status": 429,
"message": "<string>",
"data": {
"retryAfterSeconds": 123
}
}{
"defined": true,
"inferable": true,
"code": "SERVICE_UNAVAILABLE",
"status": 503,
"message": "<string>",
"data": {
"code": "COMPOSIO_FAILURE",
"message": "The integration operation could not be completed.",
"retryable": false,
"data": {
"reason": "integration_tool_unavailable",
"statusCode": 349
}
}
}Authorizations
Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.
Path Parameters
Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.
64^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
Body
2000100Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.
64^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$2 - 16Customer-visible name of an Agent.
1 - 120"Asistente de ventas"
Complete desired settings for one channel-specific Agent profile.
- Agent profile
- Agent profile
Show child attributes
Show child attributes
65536Canonical IANA timezone name.
1 - 120"America/Bogota"
Complete account-qualified desired tool access, replaced atomically as one revision.
50Show child attributes
Show child attributes
0 <= x <= 9007199254740991Customer-controlled lifecycle state of an Agent.
active, paused "active"
Response
OK
ISO 8601 timestamp with an explicit UTC offset.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$"2026-08-29T14:30:00Z"
2000Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.
64^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
Runtime family implemented by an Agent.
voice, messaging "voice"
2 - 16Customer-visible name of an Agent.
1 - 120"Asistente de ventas"
Complete desired settings for one channel-specific Agent profile.
- Agent profile
- Agent profile
Show child attributes
Show child attributes
65536Customer-controlled lifecycle state of an Agent.
active, paused "active"
Canonical IANA timezone name.
1 - 120"America/Bogota"
ISO 8601 timestamp with an explicit UTC offset.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$"2026-08-29T14:30:00Z"
True when the Agent is active and its profile can take traffic.
100Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.
64^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$The Agent's current tool allowlist and the revision that guards its next replacement.
Show child attributes
Show child attributes
curl --request PATCH \
--url https://api.getarbol.com/v1/agents/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"language": "<string>"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({language: '<string>'})
};
fetch('https://api.getarbol.com/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.getarbol.com/v1/agents/{id}"
payload = { "language": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"createdAt": "2026-08-29T14:30:00Z",
"description": "<string>",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"kind": "voice",
"language": "<string>",
"name": "Asistente de ventas",
"profile": {
"greeting": "<string>",
"channelKind": "voice",
"settings": {
"availableLanguages": [
"<string>"
],
"conversationalBehavior": {
"backgroundSound": {
"crossfadeLoop": true,
"presetId": "office1",
"volume": 0.6
},
"backgroundVoiceDetection": false,
"expressiveMode": false,
"interruptionIgnoreTerms": [],
"keywords": [],
"maxDurationMessage": "<string>",
"maxDurationSeconds": 600,
"mergeDefaultIgnoreTerms": false,
"retranscribeOnTurnTimeout": false,
"silenceEndCallTimeoutSeconds": 20,
"speculativeTurn": false,
"spellingPatience": "auto",
"transcribeOnDisabledInterruptions": false,
"turnEagerness": "normal",
"turnModel": "turn_v3",
"turnTimeoutSeconds": 7
},
"disableFirstMessageInterruptions": true,
"greetingTranslations": [
{
"language": "<string>",
"text": "<string>"
}
],
"humanTransfers": [
{
"condition": "<string>",
"phoneNumber": "+573001234567",
"transferType": "conference"
}
],
"intelligence": {
"backupLlm": {
"mode": "default",
"order": []
},
"cascadeTimeoutSeconds": 4,
"llm": "gpt-5.6-luna",
"maxTokens": -1,
"parallelToolCalls": false,
"reasoningEffort": "none",
"reasoningSummary": false,
"softTimeout": {
"enabled": false,
"message": "",
"seconds": 3
},
"temperature": 0.7
},
"toolConfigs": [
{
"config": {
"endCallDescription": "<string>",
"endCallReasons": [
"farewell"
]
},
"isEnabled": true,
"type": "END_CALL"
}
],
"voiceConfigs": [
{
"language": "<string>",
"settings": {
"similarity": 0.8,
"speed": 1,
"stability": 0.5
},
"voiceId": "<string>",
"label": "<string>"
}
]
}
},
"prompt": "<string>",
"status": "active",
"timezone": "America/Bogota",
"updatedAt": "2026-08-29T14:30:00Z",
"isRunnable": true,
"knowledgeDocumentIds": [
"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
],
"toolAccess": {
"entries": [
{
"connectedAccountId": "<string>",
"tools": [
{
"key": "google-calendar.create-event"
}
]
}
],
"revision": 4503599627370495
}
}{
"defined": true,
"inferable": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "<string>",
"data": {
"issues": [
{
"code": "custom",
"message": "<string>",
"path": [
"<string>"
]
}
],
"truncated": true
}
}{
"defined": true,
"inferable": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "FORBIDDEN",
"status": 403,
"message": "<string>",
"data": {
"missingPermissions": [
"agents:read"
]
}
}{
"defined": true,
"inferable": true,
"code": "NOT_FOUND",
"status": 404,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "CONFLICT",
"status": 409,
"message": "<string>",
"data": {
"currentRevision": 4503599627370495
}
}{
"code": "PAYLOAD_TOO_LARGE",
"defined": false,
"inferable": false,
"message": "<string>",
"data": "<unknown>"
}{
"code": "UNSUPPORTED_MEDIA_TYPE",
"defined": false,
"inferable": false,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "UNPROCESSABLE_CONTENT",
"status": 422,
"message": "<string>",
"data": {
"reason": "primary_voice_missing"
}
}{
"defined": true,
"inferable": true,
"code": "TOO_MANY_REQUESTS",
"status": 429,
"message": "<string>",
"data": {
"retryAfterSeconds": 123
}
}{
"defined": true,
"inferable": true,
"code": "SERVICE_UNAVAILABLE",
"status": 503,
"message": "<string>",
"data": {
"code": "COMPOSIO_FAILURE",
"message": "The integration operation could not be completed.",
"retryable": false,
"data": {
"reason": "integration_tool_unavailable",
"statusCode": 349
}
}
}