Skip to content
CaviusConnect
Documentation menu

Getting started

Send your first message in a few minutes. All you need is a CaviusConnect account and an API key.

1. Create an account

Sign up for free, then verify your email and sign in to the dashboard.

2. Create an API key

In the dashboard, go to Developer → API keys and create a key. Give it a name and the scopes it needs (for example messages:send and contacts:read).

The full key is shown only once, on creation. Store it in a secrets manager or environment variable; you won't be able to read it again.

Keys are prefixed ck_live_… for production and ck_test_… for test mode. See Authentication for how keys and scopes work.

Sending email? Platform-managed email requires a verified sending domain: add your domain under Channels → Email, publish the DKIM/SPF DNS records shown there, and run Verify Status. Until then, email sends return 403 with code: "DOMAIN_NOT_VERIFIED". Organizations using their own SES or SendGrid credentials are exempt.

3. Install an SDK

Official SDKs are available for Node.js and Python:

# Node.js (18+)
npm install @cavius/sdk

# Python (3.9+)
pip install cavius

You can also call the REST API directly; every SDK method maps to a documented endpoint.

4. Send your first SMS

Node.js

import { Cavius } from "@cavius/sdk";

const client = new Cavius({ apiKey: process.env.CAVIUS_API_KEY });

await client.messages.send({
  to: "+15555550100",
  channel: "SMS",
  body: "Hello from CaviusConnect!",
});

Python

import os
from cavius import Cavius

client = Cavius(api_key=os.environ["CAVIUS_API_KEY"])

client.messages.send(
    to="+15555550100",
    channel="SMS",
    body="Hello from CaviusConnect!",
)

The SDKs default to the production base URL https://core.caviusconnect.com; override it with the baseUrl / base_url option if you're pointed at another environment.

Next steps