GET /v1/agents
const url = 'https://seu-endereco-da-api/v1/agents';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://seu-endereco-da-api/v1/agents \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler agentes de IA (agents:read).
Authorizations
Seção intitulada “Authorizations”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
Example
[ { "status": "active", "outOfHours": "avisar", "voiceReply": "never", "voice": "alloy" }]