Referência da API

Construa integrações personalizadas, automatize fluxos de trabalho e gerencie assistentes de forma programática.

Nota: A API da aplicação CollowAI é executada na Railway. Há endpoints REST disponíveis para chat do widget, webhooks e acesso programático. Consulte as seções abaixo para mais detalhes.

Endpoints HTTP

Estes endpoints HTTP estão disponíveis para incorporação de widget e tratamento de webhooks:

POST/api/chat

Envie uma mensagem para um assistente e receba uma resposta gerada por IA. Usado pelo widget incorporável. Aceita ID do assistente, mensagem do usuário e contexto de conversa opcional.

POST/api/webhooks/polar

Receptor de webhook para eventos de pagamento Polar.sh (assinaturas, faturas, etc.). Configure isso nas configurações da sua organização Polar.sh.

API Backend

A API da aplicação CollowAI é executada na Railway. Todos os endpoints estão acessíveis via API REST. Grupos de recursos comuns incluem:

Assistentes

Crie, atualize, delete e consulte assistentes. Gerencie suas configurações, modelos e status.

Conversas

Liste conversas, envie mensagens e recupere o histórico de mensagens para qualquer assistente.

Fontes de Conhecimento

Faça upload de documentos, gerencie conexões de banco de dados e configure bases de conhecimento para cada assistente.

Integrações

Conecte e gerencie integrações de terceiros, visualize o status de sincronização e dispare sincronizações manuais.

Configuração do Widget

Configure e recupere as configurações do widget, incluindo marca, posicionamento e CSS personalizado para chat incorporado.

Segundo Cérebro

Consulte conhecimento estruturado: entidades, fatos, tópicos, relacionamentos e conflitos extraídos dos seus documentos.

Faturamento e Assinaturas

Consulte o status da assinatura, liste faturas e gerencie informações de faturamento.

Uso do SDK Client

Para integrações personalizadas, use a API REST diretamente:

# List assistants
curl -H "Authorization: Bearer assai_*" \
  https://api.collowai.com/api/v1/assistants

# Create an assistant
curl -X POST \
  -H "Authorization: Bearer assai_*" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Assistant"}' \
  https://api.collowai.com/api/v1/assistants

# Get Second Brain stats
curl -H "Authorization: Bearer assai_*" \
  https://api.collowai.com/api/v1/assistants/{assistantId}/brain/stats

# List brain entities
curl -H "Authorization: Bearer assai_*" \
  https://api.collowai.com/api/v1/assistants/{assistantId}/brain/entities

# List brain facts
curl -H "Authorization: Bearer assai_*" \
  https://api.collowai.com/api/v1/assistants/{assistantId}/brain/facts

# List brain topics
curl -H "Authorization: Bearer assai_*" \
  https://api.collowai.com/api/v1/assistants/{assistantId}/brain/topics

# List brain relationships
curl -H "Authorization: Bearer assai_*" \
  https://api.collowai.com/api/v1/assistants/{assistantId}/brain/relationships

# List brain conflicts
curl -H "Authorization: Bearer assai_*" \
  https://api.collowai.com/api/v1/assistants/{assistantId}/brain/conflicts

# Get brain extractions history
curl -H "Authorization: Bearer assai_*" \
  https://api.collowai.com/api/v1/assistants/{assistantId}/brain/extractions

Autenticação

Requisições de API são autenticadas usando chaves de API geradas a partir do seu painel (Configurações > Chaves de API). Inclua sua chave no cabeçalho Authorization:

Authorization: Bearer YOUR_API_KEY