Agentes
Estes endpoints permitem listar e consultar os agentes da sua organização. Use-os para descobrir quais agentes estão disponíveis, ler suas configurações ou integrar a listagem de agentes em ferramentas externas.
GET /agents
Section titled “GET /agents”Lista todos os agentes da organização com informações resumidas.
Parâmetros de query
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
limit | inteiro | 50 | Número máximo de resultados. Máximo: 100. |
offset | inteiro | 0 | Deslocamento para paginação. |
active | booleano | true | Filtrar apenas agentes ativos (true) ou inativos (false). |
curl https://api.squados.io/v1/agents?limit=10&offset=0&active=true \ -H "Authorization: Bearer pk_sua_chave_aqui"Resposta 200
{ "agents": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Suporte ao Cliente", "description": "Agente de atendimento com conhecimento da base de produtos.", "model": "gpt-4o-mini", "avatar_url": "https://cdn.squados.io/avatars/a1b2c3d4.png", "is_public": true, "active": true, "temperature": 0.7, "history_limit": 20, "created_at": "2026-01-15T10:30:00Z", "conversation_count": 1482, "bases_count": 2 }, { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Assistente Interno", "description": "Responde dúvidas da equipe sobre processos internos.", "model": "claude-3-5-haiku", "avatar_url": null, "is_public": false, "active": true, "temperature": 0.4, "history_limit": 10, "created_at": "2026-02-20T14:00:00Z", "conversation_count": 214, "bases_count": 1 } ], "total": 2, "limit": 10, "offset": 0}GET /agents/{agentId}
Section titled “GET /agents/{agentId}”Retorna os detalhes completos de um agente, incluindo o prompt do sistema, modelo, bases de conhecimento vinculadas e contagem de ferramentas.
Parâmetros de caminho
| Parâmetro | Tipo | Descrição |
|---|---|---|
agentId | UUID | ID do agente. |
curl https://api.squados.io/v1/agents/AGENT_ID \ -H "Authorization: Bearer pk_sua_chave_aqui"Resposta 200
{ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Suporte ao Cliente", "description": "Agente de atendimento com conhecimento da base de produtos.", "prompt": "Você é um assistente de suporte ao cliente da Acme. Seu objetivo é resolver dúvidas sobre produtos, pedidos e devoluções de forma objetiva e amigável. Sempre cumprimente o cliente pelo nome quando disponível.", "model": "gpt-4o-mini", "model_details": { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "name": "GPT-4o mini", "provider": "OpenAI", "supports_vision": true, "supports_files": true }, "avatar_url": "https://cdn.squados.io/avatars/a1b2c3d4.png", "is_public": true, "active": true, "temperature": 0.7, "history_limit": 20, "created_at": "2026-01-15T10:30:00Z", "bases": [ { "id": "d4e5f6a7-b8c9-0123-defa-234567890123", "name": "Catálogo de Produtos" }, { "id": "e5f6a7b8-c9d0-1234-efab-345678901234", "name": "Políticas de Devolução" } ], "tools_count": 3, "conversation_count": 1482}Erros
| Status | Código | Descrição |
|---|---|---|
404 | AGENT_NOT_FOUND | Nenhum agente com esse ID foi encontrado na organização. |
Consulte Erros para o formato completo das respostas de erro.