Administrar
API
Chame agentes, conhecimentos e conversas por HTTP com a chave do workspace.
A API pública permite criar e consultar agentes, conhecimentos e conversas a partir do seu sistema. Todas as rotas ficam em /api/v1 e valem para o workspace da chave.
Autenticação
Envie a chave do workspace no cabeçalho Authorization, no formato Bearer. A chave se cria em Espaços e equipe, na aba de chaves do workspace.
curl -X POST https://SEU-DOMINIO/api/v1/agents/ID_DO_AGENTE/query \
-H "Authorization: Bearer SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{"query": "Qual é o prazo de entrega?", "conversationId": null}'Sem conversationId a API abre uma conversa nova e devolve o id dela. Mande esse id nas próximas perguntas para continuar o assunto.
Rotas principais
| Rota | O que faz |
|---|---|
| POST /api/v1/agents | Cria um agente. |
| GET, PATCH, DELETE /api/v1/agents/ID | Lê, atualiza ou apaga um agente. |
| POST /api/v1/agents/ID/query | Faz uma pergunta ao agente. |
| POST /api/v1/datastores | Cria um conhecimento. |
| POST /api/v1/datastores/ID/query | Busca trechos de um conhecimento. |
| POST /api/v1/datasources | Adiciona uma fonte a um conhecimento. |
| GET /api/v1/conversations | Lista conversas, com filtros. |
| POST /api/v1/conversations/ID/message | Envia uma mensagem a uma conversa. |
| POST /api/v1/campaigns/new | Cria uma campanha e, se pedir, já dispara. |
Respostas e erros
- 401: faltou a chave ou ela é inválida.
- 403: a chave não tem permissão para esse recurso.
- 404: o item não existe neste workspace.
- 429: muitas chamadas. O limite padrão é de 60 por minuto por chave.
Cada workspace enxerga só o que é seu
Uma chave nunca lê nem altera dados de outro workspace, mesmo que você informe o id de um item de fora. Nesse caso a resposta é 404.