Skip to main content

stopAgent

client.agents.stopAgent(data: StopAgentRequest): Promise<void>

Stops a running agent.

Sends a stop signal to the specified agent, causing it to terminate gracefully.

Parameters

ParameterTypeRequiredDescription
dataStopAgentRequestYesThe stop request configuration

Returns

Promise<void> — A promise that resolves when the agent has been stopped

Example

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

const client = new CodeBoltClient();

const result = await client.agents.stopAgent(/* StopAgentRequest */);
console.log(result);