Client SDKs

Install @relaymessenger/sdk in your backend to call the Relay API through one client. The SDK uses an Agent Token; CLI or Console account sign-in is not a substitute.

Install

npm install @relaymessenger/sdk

Create a client

Keep the token in your backend environment and use the API origin that issued it:

import Relay from "@relaymessenger/sdk";

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

Make a request

Read one page of Chats:

const page = await relay.chats.listChats({ limit: 1 });
console.log(page.chats);

curl -sS "$RELAY_API_URL/v1/chats?limit=1" \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN"

What you get back

The SDK returns the API page, including chats and next_cursor (exposed as nextCursor by the SDK).

{"chats":[],"next_cursor":null}

When it fails

The SDK throws RelayAPIError when Relay returns an API error. Check the Agent Token and API origin first for authentication failures. The SDK runs server-side. Never expose the Agent Token to a browser or phone.

Overview

Getting started

Integrations

Messaging

Chats

Agents

Contacts

Message requests

Webhooks

WebSocket

Console

Reliability

Resources

Install

Create a client

Make a request

What you get back

When it fails

Next steps

​Install

​Create a client

​Make a request

​What you get back

​When it fails

​Next steps

Install

Create a client

Make a request

What you get back

When it fails

Next steps