Sign in
Swarms

Update a journey

Editing a journey never disturbs a run already under way: a run pins its own immutable snapshot of the definition at launch.

patch/projects/{projectId}/journeys/{journeyId}

Request body

namestring
goalstring
environmentIdsstring[] nullable

A non-empty list to set, or null to clear and fall back to host targets.

serverAttachmentIdstring nullable

null clears the attachment.

hostIdsstring[]
sessionsPerTargetinteger
maxTurnsinteger

Response

The updated journey.

idstring required
projectIdstring required
namestring required
goalstring required

What the persona is trying to accomplish. This drives the whole run.

personaIdstring required
swarmIdstring nullable required

The swarm container this journey was authored under. Provenance only — nothing resolves through it at run time, and a journey created outside a swarm has none.

environmentIdsstring[] required

Environments this journey fans out across. EMPTY on a host-pinned journey — that is a different execution model, not a journey with no targets.

serverAttachmentIdstring

Legacy host-pinned grounding. Absent on an environment-based journey.

sessionsPerTargetinteger nullable required

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

maxTurnsinteger nullable required
createdAtnumber required

Epoch milliseconds.

updatedAtnumber required

Epoch milliseconds.

Changes

Changed in 1 of the 71 revisions of this API.1