Quickstart

Aelyst is an AI-powered CRM and messaging platform that lets you manage conversations, automate replies, and orchestrate follow-ups across every channel from a single API. Whether you're building a support tool, wiring up an AI agent, or managing multiple workspaces, the Aelyst API gives you complete control.

Base URL: https://api.aelyst.com/v1

Install the SDK

npm install @aelyst/node

pip install aelyst

go get github.com/aelyst/aelyst-go

composer require aelyst/aelyst-php

gem install aelyst

<dependency>
  <groupId>com.aelyst</groupId>
  <artifactId>aelyst-java</artifactId>
  <version>1.0.0</version>
</dependency>

Authentication

All API requests require an API key. The SDKs read from the AELYST_API_KEY environment variable by default.

Getting Your API Key

1. Log in to your Aelyst workspace at app.aelyst.com
2. Go to Settings → API Keys
3. Click Create API Key
4. Copy the key immediately — it's only shown once

Set Up the Client

import { Aelyst } from '@aelyst/node';

const aelyst = new Aelyst({
  apiKey: process.env.AELYST_API_KEY,
});

from aelyst import Aelyst

aelyst = Aelyst(api_key=os.environ["AELYST_API_KEY"])

Key Concepts

Before you start, it helps to understand the core objects you'll work with:

• Workspace — the tenant that owns channels, contacts, and conversations.
• Channel — a connected messaging account (WhatsApp, Instagram DM, etc.).
• Contact — a person you're talking to, unified across channels.
• Conversation — a threaded exchange between a contact and your workspace.
• Agent — an AI worker that reads, replies, and takes actions autonomously.

Step 1: Create a Contact

const contact = await aelyst.contacts.create({
  name: 'Andi Wijaya',
  phone: '+6281234567890',
  tags: ['lead', 'website'],
});

Step 2: Connect a Channel

Channels are connected through OAuth from the dashboard, or hosted via the API. Aelyst supports the major messaging platforms out of the box.

Available Channels

• WhatsApp Business
• Instagram DM
• Facebook Messenger
• Telegram
• Email

const { authUrl } = await aelyst.channels.connect({
  provider: 'whatsapp',
  redirectUrl: 'https://yourapp.com/callback',
});

Step 3: Get Your Connected Channels

const channels = await aelyst.channels.list();
// [{ id: 'ch_123', provider: 'whatsapp', status: 'active' }]

Step 4: Send Your First Message

await aelyst.messages.send({
  channelId: 'ch_123',
  contactId: contact.id,
  text: 'Halo! Terima kasih sudah menghubungi kami 👋',
});

Sending to Multiple Channels

Reach a contact on whichever channel they last used — Aelyst routes it for you:

await aelyst.messages.send({
  contactId: contact.id,
  channel: 'auto', // picks the contact's most recent active channel
  text: 'Your order is on its way.',
});

Attaching an AI Agent

Hand the conversation to an agent that replies and takes actions on its own:

await aelyst.conversations.assignAgent({
  conversationId: 'conv_456',
  agentId: 'agent_support',
});

Scheduling a Follow-up

await aelyst.followups.schedule({
  contactId: contact.id,
  runAt: '2026-07-05T09:00:00+07:00',
  text: 'Just checking in — did you have any other questions?',
});

What's Next?

• Read the Agents guide to build autonomous AI workers.
• Explore Webhooks to react to incoming messages in real time.
• Browse the full API Reference for every endpoint.