Sign in
Swarms

Create a swarm

A swarm is an authoring container holding DEFAULTS for the goals made under it. Creating one starts nothing.

post/projects/{projectId}/swarms

Headers

Idempotency-Keystring

Retry-safe create key. Replaying the SAME key with the SAME body returns the original resource instead of creating a second one; reusing it with a DIFFERENT body is a 409.

Request body

OR

Response

The created swarm.

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

Default fan-out for goals authored under this container.

iterationsinteger nullable required

Sessions run against EACH target. Total sessions = targets x this.

sessionsPerTargetinteger nullable required

Pre-rename spelling of iterations, emitted alongside it until general availability.

maxTurnsinteger nullable required
setupWritesboolean

Whether prerequisite setup may create or modify workspace data before sessions run. Defaults to false.

createdAtnumber required

Epoch milliseconds.

updatedAtnumber required

Epoch milliseconds.

Changes