Automações e canais
Como programar tarefas da VI, ligar e desligar seus recursos e usá-la em canais de atendimento e de compra.
Esta seção reúne o que faz a VI trabalhar sem uma conversa aberta: as rotinas (tarefas escritas em linguagem natural que rodam em horário fixo), o SAC resolutivo (a VI respondendo mensagens de pós-venda dos clientes) e a loja pronta para agentes (abertura da loja para assistentes de compra externos). Também documenta as configurações que ligam ou desligam cada recurso da VI na loja.
Como funciona
Ciclo de vida de uma rotina
status | Significado |
|---|---|
draft | Criada ou editada; ainda não roda sozinha |
active | Roda no horário agendado |
paused | Parada pelo administrador; pode ser retomada |
archived | Excluída (a exclusão é lógica) |
- Compile
POST /routines/compiletransforma o texto ("todo dia às 8h resuma os pedidos de ontem") em um plano de passos. Nada é salvo. - Revise e salveMostre o plano ao administrador e salve com
POST /routines. Passos que escrevem na loja vêm comis_write: true. - Ative
POST /routines/{id}/resumecoloca a rotina emactive. - Acompanhe
GET /routines/{id}/runslista as execuções.POST /routines/{id}/runroda uma vez, na hora.
Conceitos-chave
Aprovação
Com require_approval: true, a execução para no primeiro passo que escreve na loja e registra a execução como waiting_approval. Passos de leitura rodam normalmente. Esta API não tem rota para aprovar uma execução parada: para rotinas que precisam escrever sem intervenção, use require_approval: false, ciente de que a escrita acontece sozinha.
Regras de negócio
Antes de cada passo que escreve, a plataforma confere as memórias do tipo rule com conteúdo estruturado (Memórias). Se o valor do passo viola uma regra (por exemplo, um desconto acima do máximo), a execução falha naquele passo.
Interruptores
Cada recurso da VI tem uma chave em Configurações. As chaves enable_* valem ligadas quando ausentes; proactive_nudges_enabled, o SAC e a loja pronta para agentes valem desligadas.
Rotas
Todas exigem Authorization: Bearer $TOKEN de um administrador.
| Método | Caminho (após /api/v1/admin/intelligence) | Para que serve | Página |
|---|---|---|---|
| GET | /routines | Listar rotinas | routines |
| POST | /routines | Criar | routines |
| GET | /routines/{id} | Ler | routines |
| PATCH | /routines/{id} | Alterar | routines |
| DELETE | /routines/{id} | Excluir | routines |
| POST | /routines/compile | Compilar texto em plano | routines-run |
| POST | /routines/{id}/pause | Pausar | routines-run |
| POST | /routines/{id}/resume | Ativar/retomar | routines-run |
| POST | /routines/{id}/run | Rodar agora | routines-run |
| GET | /routines/{id}/runs | Listar execuções | routines-run |
| GET | /settings | Ler configurações | settings |
| PUT | /settings | Substituir configurações | settings |
| GET | /sac/settings | Ler o SAC | sac |
| PUT | /sac/settings | Alterar o SAC | sac |
| GET | /sac/actions | Ações do SAC numa conversa | sac |
| PUT | /sac/threads/{id}/agent | Controlar a VI numa conversa | sac |
| GET | /agent-commerce/settings | Ler a loja pronta para agentes | agent-commerce |
| PUT | /agent-commerce/settings | Ligar ou desligar | agent-commerce |
Erros comuns
- Salvar a rotina e esperar que ela rode. Ela nasce
draft. Falta oresume. - Editar uma rotina ativa e achar que continua ativa.
PATCHvolta o status paradrafte zerarequire_approvalquando você não o reenvia. - Mandar um
PUT /settingsparcial. Tudo que você não enviar é apagado, inclusive as chaves do SAC e da loja pronta para agentes. - Mandar
PUT /sac/settingssó comenabled. Os outros dois campos viramfalse. - Esperar
404em rotinas que não existem. Várias rotas respondem400ou500com a mensagem do banco; confira oidantes. - Passar de 20 rotinas ativas.
resumeresponde409.