Skip to main content

Conceito

Um Agent é o núcleo da Timely.ai — é a entidade de IA que recebe mensagens dos seus clientes, processa o contexto da conversa e responde de forma autônoma com base no comportamento, na base de conhecimento (Trainings) e nos canais conectados a ele. Cada agente tem identidade própria (nome, personalidade, idioma), regras de comportamento configuráveis e pode ser conectado a múltiplos canais simultaneamente (WhatsApp, Instagram, Telegram, widget de site). Você pode ter múltiplos agentes no mesmo workspace, cada um especializado em uma área diferente — suporte, vendas, financeiro — com bases de conhecimento e configurações independentes.

Ciclo de vida

criar (inactive)


configurar (settings, trainings, channels)


ativar → active ──────────────────────────────┐
    │                                          │
    │   recebe mensagens → processa → responde │
    │                                          │
    ▼                                          │
desativar → inactive ◄─────────────────────────┘


deletar (soft delete — dados preservados)
Um agente inactive não processa novas mensagens, mas seu histórico de conversas e configurações são mantidos. O soft delete garante que dados históricos não sejam perdidos acidentalmente.

Campos principais

CampoTipoDescrição
idstring (UUID)ID único do agente
namestringNome do agente exibido para o cliente
statusenumactive | inactive
descriptionstringDescrição interna do propósito do agente
languagestringIdioma principal (ex.: pt-BR)
modelstringModelo de LLM usado (ex.: gpt-4o)
system_promptstringPrompt de sistema base do comportamento
created_atstringISO 8601 de criação
updated_atstringISO 8601 da última atualização
credits_remainingnumberCréditos disponíveis para o agente

Endpoints disponíveis

Consulte a barra lateral à esquerda para a lista completa de endpoints deste grupo. Cada endpoint tem sua própria página com schema de request/response, exemplos em cURL/JS/Python e playground interativo.

Próximos passos

Primeira requisição

Se você ainda não fez sua primeira chamada, comece por aqui.