@videosdk.live/server-sdk
    Preparing search index...

    Interface VideoSDKClientOptions

    interface VideoSDKClientOptions {
        apiEndpoint?: string;
        apiKey?: string;
        fetch?: FetchLike;
        headers?: Record<string, string>;
        maxRetries?: number;
        secret?: string;
        timeoutMs?: number;
        token?: string;
        tokenOptions?: ClientTokenOptions;
        webhookPublicKey?: string;
    }
    Index
    apiEndpoint? apiKey? fetch? headers? maxRetries? secret? timeoutMs? token? tokenOptions? webhookPublicKey?
    apiEndpoint?: string

    API endpoint. Defaults to https://api.videosdk.live (falls back to VIDEOSDK_API_ENDPOINT).

    apiKey?: string

    Project API key. Falls back to VIDEOSDK_API_KEY. Required unless a static VideoSDKClientOptions.token is given.

    fetch?: FetchLike

    Custom fetch implementation (defaults to global fetch, Node 18+).

    headers?: Record<string, string>

    Extra headers added to every request.

    maxRetries?: number

    Max retries for network errors / 429 / 5xx. Defaults to 2.

    secret?: string

    Project secret. Falls back to VIDEOSDK_SECRET. Required unless a static token is given.

    timeoutMs?: number

    Per-request timeout in milliseconds. Defaults to 30000.

    token?: string

    A pre-generated token used verbatim. When set, the client won't (and can't) auto-refresh; supply apiKey/secret instead for long-lived use.

    tokenOptions?: ClientTokenOptions

    Claims/expiry for auto-generated tokens (permissions, roles, version, expiresIn).

    webhookPublicKey?: string

    Pin the RSA public key (PEM) used by webhooks.verify (skips the network fetch).

    Settings
    Member Visibility

    On This Page
    Properties