Class VideoSDK

The VideoSDK server SDK client.

Credentials fall back to the VIDEOSDK_API_KEY / VIDEOSDK_SECRET env vars.

Example

const vsdk = new VideoSDK();                                   // env-var fallback
const vsdk = new VideoSDK({ apiKey, secret });                 // explicit
const room = await vsdk.rooms.create({ geoFence: "sg001" });

Index

Constructors

constructor

Methods

accessToken generateToken request verifyToken generateToken

Constructors

constructor

new VideoSDK(options?: VideoSDKClientOptions): VideoSDK
Parameters
- options: VideoSDKClientOptions = {}
Returns VideoSDK

Properties

`Readonly`agents

agents: AgentsResource

AI Agents API — dispatch agents into rooms / calls.

`Readonly`alertRules

alertRules: AlertRulesResource

Alert rules API (+ notification channels & metrics).

`Readonly`api

api: ApiFacade

Raw HTTP escape hatch (vsdk.api.get/post/...) with auth + retries applied.

`Readonly`apiEndpoint

apiEndpoint: string

The resolved API endpoint.

`Readonly`batchcall

batchcall: BatchCallsResource

Batch-calls API — bulk outbound phone campaigns.

`Readonly`connectors

connectors: ConnectorsResource

Connectors API — per-provider telephony webhook ingress.

`Readonly`hls

hls: HlsResource

HLS API.

`Readonly`incidents

incidents: IncidentsResource

Incidents API.

`Readonly`participants

participants: ParticipantsResource

Participants API — a room-scoped view of live participants.

`Readonly`recordings

recordings: RecordingsResource

Recordings API (room / participant / track / composite / merge).

`Readonly`resourcePool

resourcePool: ResourcePoolResource

Resource pool API — pre-acquire composition units (Enterprise).

`Readonly`rooms

rooms: RoomsResource

Rooms (meetings) API.

`Readonly`rtmp

rtmp: RtmpResource

RTMP-out (livestream) API.

`Readonly`sessions

sessions: SessionsResource

Sessions & participants API.

`Readonly`sip

sip: SipResource

SIP / telephony API (gateways, routing rules, phone numbers, calls, webhooks).

`Readonly`socketIngress

socketIngress: SocketIngressResource

Socket ingest — single-use WS URL to stream media/data frames into a room.

`Readonly`transcodings

transcodings: TranscodingsResource

Transcodings API.

`Readonly`transcription

transcription: TranscriptionResource

Transcription API — vsdk.transcription.realtime (live transcription).

`Readonly`webhooks

webhooks: WebhooksResource

Webhooks API — verify inbound webhook signatures.

`Readonly`whep

whep: WhepResource

WHEP egress — client-side pull URL + token builder.

`Readonly`whip

whip: WhipResource

WHIP ingress — client-side publish URL + token builder.

Methods

accessToken

accessToken(): AccessTokenBuilder
Start building an access token (fluent). Defaults to a participant token (roles: ["rtc"]); call .forApi() for a management token.

Returns AccessTokenBuilder
Example
```
const token = vsdk.accessToken().setParticipant("u1").grant(Grant.AllowJoin).forRoom(roomId).expiresIn("15m").toJwt();
```

generateToken

generateToken(overrides?: Partial<GenerateTokenOptions>): string
Mint a fresh token from this client's credentials, overriding any default token options. (Prefer the VideoSDK access-token builder for participant tokens.)
Parameters
- overrides: Partial<GenerateTokenOptions> = {}
Returns string

request

request<T = unknown>(
    method: string,
    path: string,
    options?: RequestOptions,
): Promise<T>
Escape hatch: call any endpoint with a dynamic method. For a fixed verb, VideoSDK.api (vsdk.api.get/post/...) reads better.
Type Parameters
- T = unknown
Parameters
- method: string
- path: string
- Optionaloptions: RequestOptions
Returns Promise<T>

verifyToken

verifyToken(jwt: string): DecodedTokenPayload
Verify a token against this client's secret and return its claims. Throws AuthenticationError if the token is invalid or expired.
Parameters
- jwt: string
Returns DecodedTokenPayload

`Static`generateToken

generateToken(options: GenerateTokenOptions): string
Static convenience for generateToken.
Parameters
- options: GenerateTokenOptions
Returns string

Class VideoSDK

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VideoSDK

Properties

Readonlyagents

ReadonlyalertRules

Readonlyapi

ReadonlyapiEndpoint

Readonlybatchcall

Readonlyconnectors

Readonlyhls

Readonlyincidents

Readonlyparticipants

Readonlyrecordings

ReadonlyresourcePool

Readonlyrooms

Readonlyrtmp

Readonlysessions

Readonlysip

ReadonlysocketIngress

Readonlytranscodings

Readonlytranscription

Readonlywebhooks

Readonlywhep

Readonlywhip

Methods

accessToken

Returns AccessTokenBuilder

Example

generateToken

Parameters

Returns string

request

Type Parameters

Parameters

Returns Promise<T>

verifyToken

Parameters

Returns DecodedTokenPayload

StaticgenerateToken

Parameters

Returns string

Settings

On This Page

`Readonly`agents

`Readonly`alertRules

`Readonly`api

`Readonly`apiEndpoint

`Readonly`batchcall

`Readonly`connectors

`Readonly`hls

`Readonly`incidents

`Readonly`participants

`Readonly`recordings

`Readonly`resourcePool

`Readonly`rooms

`Readonly`rtmp

`Readonly`sessions

`Readonly`sip

`Readonly`socketIngress

`Readonly`transcodings

`Readonly`transcription

`Readonly`webhooks

`Readonly`whep

`Readonly`whip

`Static`generateToken