latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-15140179507.6 KB

d3adfe49fbbf

Swarms

Update a swarm

Changes the container's DEFAULTS. Journeys already authored under it keep the values they were created with — this is not a cascade.

patch/projects/{projectId}/swarms/{swarmId}

Request body

namestring
descriptionstring nullable
environmentIdsstring[] nullable
sessionsPerTargetinteger
maxTurnsinteger

Response

The updated swarm.

idstring required
projectIdstring required
namestring required
descriptionstring nullable required
environmentIdsstring[] required

Default fan-out for journeys authored under this container.

sessionsPerTargetinteger nullable required
maxTurnsinteger nullable required
createdAtnumber required

Epoch milliseconds.

updatedAtnumber required

Epoch milliseconds.