Skip to main content
GET
/
agents
Listar agentes
curl --request GET \
  --url https://api.cordialy.ai/integrations/v1/agents \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "priority": 123,
    "is_active": true,
    "is_default": true,
    "voice_id": "<string>",
    "audio_response_enabled": true,
    "condition_groups": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "group_index": 123,
        "logical_operator": "AND",
        "conditions": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "value": "<string>"
          }
        ]
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
X-API-Key
string
header
required

Chave de API gerada na plataforma em Integrações → API Keys

Response

200 - application/json

Lista de agentes

​
id
string<uuid>
​
name
string

Nome do agente

​
model
enum<string>

auto = usa o padrão da loja, gemini = Google Gemini, openai = OpenAI GPT-4

Available options:
auto,
gemini,
openai
​
priority
integer

Prioridade de seleção (menor número = maior prioridade)

​
is_active
boolean
​
is_default
boolean

Agente padrão usado quando nenhuma condição for satisfeita

​
voice_id
string | null

ID de voz ElevenLabs para respostas em áudio

​
audio_response_enabled
boolean

Responde com áudio quando o lead enviar áudio

​
condition_groups
object[]

Grupos de condições de ativação (OR entre grupos, AND dentro de cada grupo)

​
created_at
string<date-time>
​
updated_at
string<date-time>