Skip to main content

initiateNewThread

plugin.chatApi.initiateNewThread(data: InitiateNewThreadRequest): Promise<ChatThreadInfo>

Initiates a new chat thread or retrieves an existing one.

Creates a new thread if one doesn't exist for the given context, or returns the existing thread. This is the primary entry point for starting a conversation.

Parameters

ParameterTypeRequiredDescription
dataInitiateNewThreadRequestYesThe thread initiation request

Returns

Promise<ChatThreadInfo> — A promise that resolves to the ChatThreadInfo for the new or existing thread

Example

import plugin from '@codebolt/plugin-sdk';

const result = await plugin.chatApi.initiateNewThread(/* InitiateNewThreadRequest */);
console.log(result);