agent.createThread()

`agent.createThread()`

Creates a new assistant thread and first message. Instructions, contextMode and responseFormat are immutable thread settings; follow-ups and Resume reuse them. Minimal retains instance-global/account standing instructions and security while omitting automatic context. Minimal admits only explicit toolNames or selected plugin routes. JSON schemas are strict and locally validated. message is the user input; assistantMessage.message is the final text, and output.json is validated JSON when requested. Requires readOnly: false.

Overloads

static createThread(
      data: AssistantMessageInput,
    ): Promise<AssistantThreadResponse>;

static createThread(
      data: AssistantMessageInput,
      stream: AssistantStreamOptions,
    ): Promise<ExecutionStream<AssistantThreadResponse>>;

Example

const response = await agent.createThread({
  content: 'Siemka jestem testerem.',
  instructions: 'Translate Polish to English. Return only the translation.',
  contextMode: 'minimal',
  responseFormat: { type: 'text' },
  toolNames: [],
});
return response.assistantMessage?.message;

See all agent methods or runtime basics.

Last modified on November 8, 2026

Low-code method reference

Developer tools

Before you start

Platform API

agent.createThread()