Getting started

Quickstart

Current documentation

Learn the authenticated send flow and the readiness checks that must pass first.

1. Get your API key

Sign in with your email, then open Settings. API keys are for technical integrations only. Keep them server-side.

2. Send a message

curl -X POST https://beam.aisync.link/v1/messages \
  -H "x-api-key: YOUR_WORKSPACE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+15551234567",
    "message": "Hey Sarah, thanks for reaching out. What made you start looking?",
    "first_name": "Sarah"
  }'

const res = await fetch("https://beam.aisync.link/v1/messages", {
  method: "POST",
  headers: {
    "x-api-key": process.env.BEAM_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    to: "+15551234567",
    message: "Hey Sarah, thanks for reaching out. What made you start looking?",
    first_name: "Sarah",
  }),
});
console.log(await res.json());

import os, requests

res = requests.post(
    "https://beam.aisync.link/v1/messages",
    headers={"x-api-key": os.environ["BEAM_KEY"]},
    json={
        "to": "+15551234567",
        "message": "Hey Sarah, thanks for reaching out. What made you start looking?",
        "first_name": "Sarah",
    },
)
print(res.json())

You get back a message id and status: "queued". Beam checks whether the recipient's phone supports blue bubbles, picks the right channel, and sends at a human pace inside business hours.

3. Watch the inbox

Open your Beam inbox. The conversation appears as soon as the message sends, and the reply lands right under it. That is the whole loop.

Where did my message go?If you sent outside business hours, it is waiting for the morning window. Check it any time with Get a message.

Next steps

Connect your CRM so every new lead gets this automatically.
Turn on the human touch: reactions, typing, read receipts.
Read Best practices before writing your first-touch template.