Skip to main content

addSteeringStep

client.chat.addSteeringStep(data: AddSteeringStepRequest): Promise<SteeringStep>

Adds a steering step to a thread.

Creates a steering step that guides the agent's behavior during execution, providing directional instructions or constraints.

Parameters

ParameterTypeRequiredDescription
dataAddSteeringStepRequestYesThe steering step creation payload

Returns

Promise<SteeringStep> — A promise that resolves to the created SteeringStep

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.chat.addSteeringStep(/* AddSteeringStepRequest */);
console.log(result);