Skip to main content

startSwarm

client.swarm.startSwarm(swarmId: string, data?: StartSwarmRequest): Promise<void>

Start a swarm.

Activates a swarm, enabling it to begin processing tasks and coordinating agent activities. The swarm will start executing its assigned workflow according to its configuration.

Parameters

ParameterTypeRequiredDescription
swarmIdstringYesThe unique identifier of the swarm
dataStartSwarmRequestNoOptional start parameters

Returns

Promise<void> — A promise that resolves when the swarm has started

Example

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

const client = new CodeBoltClient();

const result = await client.swarm.startSwarm('swarmId');
console.log(result);