POST /v1/conversations/{id}/ai-goals
POST
/v1/conversations/{id}/ai-goals
const url = 'https://seu-endereco-da-api/v1/conversations/example/ai-goals';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"agentId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","kind":"agendar","objective":"example","limits":{"maxMessages":1,"deadlineAt":"example","remindAfterMinutes":1,"returnAfterMinutes":1,"maxDiscountPct":1,"maxChargeCents":1},"notifyOnFinish":true,"noteOnFinish":true,"resolveOnComplete":true,"shortcutId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","allowedActions":["agenda"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://seu-endereco-da-api/v1/conversations/example/ai-goals \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "agentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "kind": "agendar", "objective": "example", "limits": { "maxMessages": 1, "deadlineAt": "example", "remindAfterMinutes": 1, "returnAfterMinutes": 1, "maxDiscountPct": 1, "maxChargeCents": 1 }, "notifyOnFinish": true, "noteOnFinish": true, "resolveOnComplete": true, "shortcutId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "allowedActions": [ "agenda" ] }'Permissão que a Chave de acesso precisa: Pode passar conversa para a IA (ai-goals:start).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
agentId
required
string format: uuid
kind
required
string
objective
required
string
limits
required
object
maxMessages
required
number
deadlineAt
string
remindAfterMinutes
number
returnAfterMinutes
number
maxDiscountPct
number
maxChargeCents
number
notifyOnFinish
boolean
noteOnFinish
boolean
resolveOnComplete
boolean
shortcutId
string format: uuid
allowedActions
Array<string>
Responses
Seção intitulada “Responses”The goal, already conducting
Ai_credits_exhausted
Ai_goal_over_role_ceiling
Ai_goal_active or conversation_resolved
Ai_goal_agent_unavailable