Skip to content
CommunicationOS

Quickstart

Quickstart: from API key to production client.

Connect to the unified stream, execute a cross-network search, and stage an outbound draft in under one hour.

  1. 01

    Provision API credentials

    Generate a scoped API key from the developer console with read, search, and draft permissions.

  2. 02

    Install the native client library

    Add the official CommunicationOS SDK to your project using your language package manager.

  3. 03

    Authenticate and query the archive

    Initialize the client and execute your first cross-network search query across indexed message history.

  4. 04

    Subscribe to the real-time event stream

    Open a persistent WebSocket connection to receive normalized inbound message events across all connected networks.

  5. 05

    Stage an outbound response draft

    Submit a structured response payload to the operator queue for review and transmission.

npm install @communicationos/sdk

export COS_API_KEY=sk_live_...
import { CommunicationOS } from "@communicationos/sdk";

const cos = new CommunicationOS({ apiKey: process.env.COS_API_KEY });

// Search every message you have ever received, on any network.
const { results } = await cos.threads.search({
  query: "rotterdam shipment window",
  since: "2016-01-01",
});

for (const r of results) {
  console.log(r.channel, r.counterparty.name, r.sentAt, r.snippet);
}

Complete reference implementations and starter templates are available in our public GitHub repository.