Developer Documentation

Everything you need to build on the Ai Engine. API references, client libraries, and integration guides.

Quick start

01

Create a tenant

Provision a new tenant through the admin dashboard or the API. Each tenant gets isolated data, modules, and configuration.

02

Get your API key

Generate an API key from your tenant settings. Keys are scoped to specific modules and permissions.

03

Install the engine client

Install the official TypeScript client from npm. It provides typed methods for every module and handles authentication automatically.

04

Start building

Use the client to manage contacts, send emails, trigger workflows, and interact with all 23 modules programmatically.

Engine client

Install the official TypeScript client and start interacting with every module from your code.

TypeScriptnpm install @astronaut/engine-client
import { 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",
});

Module reference

Contacts

Create, update, search, and manage contact records

Pipelines

Manage deals, stages, and pipeline automations

Email

Send transactional and marketing emails via AstroMail

SMS & Voice

Send text messages and manage voice calls

Ai Assistant

Interact with Ai and access tool results

Workflows

Create, trigger, and monitor automation workflows

Forms

Create forms, manage submissions, and configure fields

Documents

Generate PDFs, manage templates, and track signatures

Courses

Manage course content, enrollments, and progress

Communities

Create groups, manage members, and moderate content

Calendar

Schedule events, manage availability, and send invites

Video Campaigns

Upload videos, create campaigns, and track views

Webinars

Configure automated webinars and registration flows

Payments

Create invoices, process payments, and manage subscriptions

QR Codes

Generate QR codes linked to forms, pages, and actions

Notifications

Configure push, email, and SMS notification rules

Full API Reference

Complete REST and WebSocket API documentation with request and response schemas, authentication details, and rate limit information. Coming soon.