Class ChatBotKit

ChatBotKit SDK - Main client class for interacting with the ChatBotKit API

This is the primary entry point for the ChatBotKit SDK. It provides access to all ChatBotKit API resources through specialized client instances.

Example

import ChatBotKit from '@chatbotkit/sdk'

const client = new ChatBotKit({
  secret: 'your-secret-key'
})

Hierarchy (View Summary)

ChatBotKitClient
- ChatBotKit

Index

Constructors

Methods

clientProxy extend

Constructors

constructor

new ChatBotKit(options: ChatBotKitClientOptions): ChatBotKit
Parameters
- options: ChatBotKitClientOptions
Returns ChatBotKit
Overrides ChatBotKitClient.constructor
- Defined in index.js:65

Methods

clientProxy

clientProxy(
    path: string,
    options?: {
        buffer?: ArrayBuffer;
        endpoint?: string;
        external?: boolean;
        fetchFn?: FetchFunction;
        file?: { data: string | ArrayBuffer; name?: string; type?: string };
        headers?: Record<string, any>;
        method?: string;
        query?: Record<string, any>;
        record?: Record<string, any>;
        retries?: number;
        retryDelay?: number;
        retryTimeout?: boolean;
        timeout?: number;
    },
): Promise<Response>
Proxies a request and resolves the upstream Response. Successful and upstream-error responses pass through untouched - streaming, binary and large bodies are preserved (the body is never read on the success path). The one exception is a CBK authorization_required signal, which is thrown as an AuthorizationRequiredError carrying the url the user must visit to authenticate.
Parameters
- path: string
- Optionaloptions: {
      buffer?: ArrayBuffer;
      endpoint?: string;
      external?: boolean;
      fetchFn?: FetchFunction;
      file?: { data: string | ArrayBuffer; name?: string; type?: string };
      headers?: Record<string, any>;
      method?: string;
      query?: Record<string, any>;
      record?: Record<string, any>;
      retries?: number;
      retryDelay?: number;
      retryTimeout?: boolean;
      timeout?: number;
  }
Returns Promise<Response>
Inherited from ChatBotKitClient.clientProxy
- Defined in client.js:646

extend

extend(extensionOptions: Partial<ChatBotKitClientOptions>): ChatBotKit
Creates a new instance of the same client type with extended options.

This is useful when you need to create a client with modified configuration (e.g., different endpoint, token, or headers) without affecting the original.

Note: This method creates a completely new instance rather than cloning, which is necessary because private class fields cannot be copied.
Parameters
- extensionOptions: Partial<ChatBotKitClientOptions>
  Options to merge with current options
Returns ChatBotKit
A new instance of the same client class with extended options
Inherited from ChatBotKitClient.extend
- Defined in client.js:442