Skip to main content

updateSteeringStep

plugin.chatApi.updateSteeringStep(threadId: string, steeringStepId: string, data: UpdateSteeringStepData): Promise<SteeringStep>

Updates a steering step in a thread.

Modifies the instruction or metadata of an existing steering step.

Parameters

ParameterTypeRequiredDescription
threadIdstringYesThe unique identifier of the thread
steeringStepIdstringYesThe unique identifier of the steering step to update
dataUpdateSteeringStepDataYesThe fields to update on the steering step

Returns

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

Example

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

const result = await plugin.chatApi.updateSteeringStep('threadId', 'steeringStepId', /* UpdateSteeringStepData */);
console.log(result);