ConvaiClient (Core API)

ConvaiClient is the main class for managing Convai in vanilla TypeScript.

Creating a Client

const client = new ConvaiClient();

You configure it when calling connect().

---

Connecting

await client.connect({
  apiKey: string;                    // Required: Your API key
  characterId: string;                // Required: Character ID
  endUserId?: string;                 // Optional: For memory & analytics
  url?: string;                       // Optional: Custom API endpoint
  enableVideo?: boolean;              // Enable video/screenshare (default: false)
  startWithVideoOn?: boolean;         // Start with camera on (default: false)
  startWithAudioOn?: boolean;         // Start with mic on (default: false)
  ttsEnabled?: boolean;               // Enable TTS (default: true)
  enableLipsync?: boolean;            // Enable blendshapes (default: false)
  blendshapeConfig?: {
    format?: 'arkit' | 'mha';         // Blendshape format (default: 'mha')
  };
  actionConfig?: {                    // Optional: Character actions
    actions: string[];
    characters: Array<{ name: string; bio: string }>;
    objects: Array<{ name: string; description: string }>;
    currentAttentionObject?: string;
  };
});

---

Connection Methods

await client.disconnect();
await client.reconnect(); // Uses last provided config
client.resetSession();    // Clears history

---

Messaging

client.sendUserTextMessage('Hello');
client.sendTriggerMessage('greet_user', 'Optional payload');

client.updateTemplateKeys({ user: 'Alex' });
client.updateDynamicInfo({ text: 'User is on the blog page' });

client.toggleTts(true);  // Enable/disable TTS

---

Media Controls

All controls are async.

// Audio
await client.audioControls.toggleAudio();
await client.audioControls.muteAudio();
await client.audioControls.unmuteAudio();
await client.audioControls.setAudioDevice('device-id');

// Video
await client.videoControls.toggleVideo();
await client.videoControls.enableVideo();
await client.videoControls.disableVideo();

// Screen share
await client.screenShareControls.toggleScreenShare();

---

Core Properties

client.state                 // Connection + activity state
client.connectionType        // 'audio' | 'video' | null
client.isBotReady            // Bot ready for messages

client.chatMessages          // Array of ChatMessage
client.userTranscription     // Live speech-to-text
client.characterSessionId    // Session ID

client.room