Client Constructor

Instance of Transport required to connect to your bot service (rtviClient.connect()). Transports define connectivity and state logic that manage the lifecycle of your session. Transports also define a protocol for message exchange between your client and bot service (such as actions, or generic messages.

If your transport package (e.g. @pipecat-ai/daily-transport) exports multiple transports classes, you can specify which to use here.

import { RTVIClient } from "@pipecat-ai/client-js";
import { DailyTransport } from "@pipecat-ai/daily-transport";

const dailyTransport = new DailyTransport();
const rtviClient = new RTVIClient({
  transport: dailyTransport,
});

Base URL to a developer hosted API that exposes various endpoints to the RTVI application.

For Pipecat client/server applications, the baseUrl is the route in your client application which will ultimately send the connect command to your Pipecat server. For example, this may be:

• http://localhost:7860 for a local development server
• /api for a serverless function (e.g. a Next.js API route)

Endpoints appended to your client base URL. RTVI will apply defaults if not provided.

You should ensure your endpoints have the necessary CORS headers set to allow requests from your client application.

const rtviClient = RTVIClient({
  params: {
    baseUrl: "/api",
    endpoints: {
      connect: "/connect", // /api/connect
      action: "/action", // /api/action
    },
  },
});

Custom request data that is passed to the baseUrl with any web request. This can be used to pass additional data to your server-side endpoint.

const rtviClient = RTVIClient({
  params: {
    baseUrl: "/api",
    requestData: {
      customData: "my custom data",
    },
  },
});

Optional Headers object that is used when making requests to the baseUrl.

Pipeline RTVI configuration passed to your bot pipeline. Must contain a valid RTVIClientConfigOption[] array.

Client configuration is optional and can be passed directly to the bot via your server-side endpoint (where sensitive information can be provided, such as API keys.)

The service order of your configuration array is important. See configuration.

Map of callback functions. See callbacks.

Time (in milleseconds) to wait for the bot to enter a ready state after calling connect(). If the timeout period is elapsed, the client will return a ConnectionTimeoutError error and disconnect from the transport.

Enable user’s local microphone device.

Enable user’s local webcam device. Note: please ensure you are using a transport package that supports video.

Enable user’s local screen share. Note: please ensure you are using a transport package that supports screen sharing.

Override the default fetch query called by rtviClient.connect(). If your server-side infrastructure has specific requirements, you can provide custom behavior here.

• params:RTVIClientParams Params provided in client constructor.
• timeout:Timeout | undefined Start timeout. You should clear this once your method resolves e.g. clearTimeout(timeout).
• abortController:AbortController - Aborting connection via abortController.abort() will reject the inflight request, clear the connection timeout and set the client to an error state.

const rtviClient = new RTVIClient({
  // ...
  customConnectHandler: async (
    params: RTVIClientParams,
    timeout: number | undefined,
    abortController: AbortController
  ): Promise<void> => {
    const connectUrl = rtviClient.constructUrl(params.endpoints.connect);
    return await fetch(connectUrl, {
      method: "POST",
      mode: "cors",
      headers: {
        "Content-Type": "application/json",
        Authorization: `Bearer ...`,
      },
      body: JSON.stringify({
        services: {...},
        config: [...],
        // ... your custom body params here
      }),
      signal: abortController?.signal,
    }).then((res) => {
      clearTimeout(timeout); // Clear the start timeout (if set)

      if (res.ok) {
        return res.json();
      }
      return Promise.reject(res);
    });
  },
});