PATCH /v1/agents/{id}
const url = 'https://seu-endereco-da-api/v1/agents/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","avatar":"example","description":"example","status":"active","replaceOnChannels":true,"model":"example","temperature":1,"instructions":"example","greeting":"example","tone":"example","length":"example","useEmojis":true,"language":"example","fallbackToHuman":true,"memory":"curta","testPhone":"example","businessHoursConfigId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","outOfHours":"avisar","forbiddenSubjects":["example"],"attemptLimit":1,"typingWaitSeconds":1,"understandAudio":true,"voiceReply":"never","voice":"alloy","channelIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"intents":[{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","name":"example","description":"example","samples":["example"],"enabled":true,"collect":[{"key":"example","label":"example","question":"example","type":"text","required":true,"options":["example"],"validationHint":"example","saveToContact":true}],"action":{"type":"reply","replyText":"example","replyVerbatim":true,"request":{"method":"GET","url":"example","headers":[{"key":"example","value":"example"}],"body":"example"},"connectionId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","transferKind":"department","transferTargetId":"example","transferLabel":"example","transferFallbackDepartmentId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","media":[{"name":"example","kind":"image","mediaKey":"example"}],"charge":{},"actions":[{}]}}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://seu-endereco-da-api/v1/agents/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "avatar": "example", "description": "example", "status": "active", "replaceOnChannels": true, "model": "example", "temperature": 1, "instructions": "example", "greeting": "example", "tone": "example", "length": "example", "useEmojis": true, "language": "example", "fallbackToHuman": true, "memory": "curta", "testPhone": "example", "businessHoursConfigId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "outOfHours": "avisar", "forbiddenSubjects": [ "example" ], "attemptLimit": 1, "typingWaitSeconds": 1, "understandAudio": true, "voiceReply": "never", "voice": "alloy", "channelIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "intents": [ { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "description": "example", "samples": [ "example" ], "enabled": true, "collect": [ { "key": "example", "label": "example", "question": "example", "type": "text", "required": true, "options": [ "example" ], "validationHint": "example", "saveToContact": true } ], "action": { "type": "reply", "replyText": "example", "replyVerbatim": true, "request": { "method": "GET", "url": "example", "headers": [ { "key": "example", "value": "example" } ], "body": "example" }, "connectionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "transferKind": "department", "transferTargetId": "example", "transferLabel": "example", "transferFallbackDepartmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "media": [ { "name": "example", "kind": "image", "mediaKey": "example" } ], "charge": {}, "actions": [ {} ] } } ] }'Permissão que a Chave de acesso precisa: Gerenciar agentes de IA (agents:manage).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”Request Bodyrequired
Seção intitulada “Request Bodyrequired”object
object
object
object
object
object
object
object
object
Responses
Seção intitulada “Responses”object
Active answers its channels; flows answers only when a flow block or another AI passes it the conversation, and never holds a channel; paused and draft answer no one (draft still answers its test phone)
Business hours the agent follows; null keeps the agent answering at any time
What the agent does outside the business hours: tell the customer the right hours, or stay silent
Subjects the owner forbids the agent to talk about, added on top of the fixed rules; empty keeps the agent as it always was
Consecutive turns without understanding before the agent hands off to a person; null never hands off for this reason
Seconds the agent waits after the customer’s last message before answering, so a burst of short messages gets one reply; null answers each message at once
True turns the customer’s audio into text before the agent answers, charged to the AI credit; false makes the agent ask the customer to write.
When the agent answers with a voice note generated from its reply, charged to the AI credit: never, only when the customer’s last message was audio, or always; replies with buttons or a list stay as text
Voice of the agent’s voice notes
object
Ready-made AI the agent was created from; null for an agent written by hand
object
Template version the agent follows
Companions that stayed in draft when the agent was turned on: a flow with an invalid graph or a sequence without steps
object
Names of the active agents of AI paused to free this agent’s channels (replaceOnChannels), joined by comma; null when none was paused
Example
{ "status": "active", "outOfHours": "avisar", "voiceReply": "never", "voice": "alloy", "companionWarnings": [ { "kind": "flow" } ]}