Client SDKs

npm install @relaymessenger/sdk

import Relay from "@relaymessenger/sdk";

const relay = new Relay({
  apiKey: process.env.RELAY_AGENT_TOKEN!,
  baseURL: process.env.RELAY_API_URL ?? "https://api.relayapp.im",
});

const result = await relay.chats.messages.send(chatId, {
  message: {
    parts: [{ type: "text", value: "Hello from Relay." }],
    idempotency_key: crypto.randomUUID(),
  },
});

const page = await relay.chats.listChats({ limit: 50 });

for await (const chat of page) {
  console.log(chat.id);
}

const relay = new Relay({
  apiKey: process.env.RELAY_AGENT_TOKEN!,
  timeout: 15_000,
  maxRetries: 2,
});

import Relay, { RelayAPIError } from "@relaymessenger/sdk";

try {
  await relay.chats.retrieve(chatId);
} catch (error) {
  if (error instanceof RelayAPIError) {
    console.error({
      status: error.status,
      code: error.code,
      traceId: error.traceId,
      docURL: error.docURL,
      retryAfter: error.retryAfter,
      retryable: error.retryable,
    });
  }
}

const relay = new Relay({
  apiKey: process.env.RELAY_AGENT_TOKEN!,
  webhookSecret: process.env.RELAY_WEBHOOK_SECRET!,
});

const event = relay.webhooks.unwrap(rawBody, {
  headers: request.headers,
});

await relay.websocket.run({
  onEvent: async (event, { sequence }) => {
    await inbox.insertOnce(event.event_id, event);
    console.log("accepted", sequence);
  },
  onFullSync: async ({ throughSequence, reason }) => {
    const snapshot = await loadCompleteRelayState(relay);
    await inbox.replaceWithSnapshot(snapshot, {
      throughSequence,
      reason,
    });
  },
});