Documentação para desenvolvedores
Tudo o que você precisa para construir sobre o Ai Engine. Referências da API, bibliotecas cliente e guias de integração.
Primeiros passos
Crie um tenant
Crie um novo tenant pelo dashboard do admin ou pela API. Cada tenant tem dados, módulos e configurações isolados.
Gere a sua chave de API
Gere uma chave de API nas configurações do seu tenant. As chaves têm escopo limitado a módulos e permissões específicos.
Instale o engine client
Instale o cliente oficial em TypeScript pelo npm. Ele oferece métodos tipados para cada módulo e cuida da autenticação automaticamente.
Comece a construir
Use o cliente para gerenciar contatos, enviar e-mails, disparar automações e interagir com todos os 23 módulos via código.
Engine client
Instale o cliente oficial em TypeScript e comece a interagir com todos os módulos direto do seu código.
npm install @astronaut/engine-clientimport { engine } from "@astronaut/engine-client";
// List all contacts
const contacts = await engine.contacts.list();
// Send an email
const result = await engine.email.send({
to: "investor@example.com",
subject: "Welcome!",
html: "<h1>Hello</h1>",
});
// Move a deal to the next stage
await engine.pipelines.moveDeal({
dealId: "deal_abc123",
stageId: "stage_qualified",
});
// Trigger a workflow
await engine.workflows.trigger({
workflowId: "wf_onboarding",
contactId: "contact_xyz",
});Referência dos módulos
Contatos
Crie, atualize, pesquise e gerencie registros de contatos
Funis
Gerencie negócios, etapas e automações do funil
Envie e-mails transacionais e de marketing pelo Ai Mail
SMS e Voz
Envie mensagens de texto e gerencie chamadas de voz
Assistente Ai
Converse com a Ai e acesse os resultados das ferramentas
Automações
Crie, dispare e monitore fluxos de automação
Formulários
Crie formulários, gerencie envios e configure campos
Documentos
Gere PDFs, gerencie modelos e acompanhe assinaturas
Cursos
Gerencie conteúdo dos cursos, matrículas e progresso
Comunidades
Crie grupos, gerencie membros e modere conteúdo
Agenda
Agende eventos, gerencie disponibilidade e envie convites
Campanhas em Vídeo
Envie vídeos, crie campanhas e acompanhe visualizações
Webinars
Configure webinars automatizados e fluxos de inscrição
Pagamentos
Crie faturas, processe pagamentos e gerencie assinaturas
QR Codes
Gere QR codes vinculados a formulários, páginas e ações
Notificações
Configure regras de notificação por push, e-mail e SMS
Referência completa da API
Documentação completa das APIs REST e WebSocket, com esquemas de requisição e resposta, detalhes de autenticação e informações sobre limites de uso. Em breve.