Docs
Node SDK

context

Identify the project, environment and scopes of the supplied key.

Import and client

TypeScript
import { RelayServer } from '@relayrtc/node'
 
const relay = new RelayServer({
  apiUrl: process.env.RELAYRTC_API_URL!,
  apiKey: process.env.RELAYRTC_SECRET_KEY!,
})

Requirements

A valid secret API key. No additional management scope is required.

Parameters

No resource or query parameters.

Every method accepts RequestOptions as its final argument.

Example

TypeScript
const result = await relay.context()

Returns

Promise<ApiContext>. Returns the project, environment and scopes for the configured secret key.

REST equivalent

GET /v1/. Failures throw RelayApiError.