Swarms

Create a swarm

Changed on

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

post/projects/{projectId}/swarms

Request

  • Base URL
    https://app.mcpjam.com/api/v1
  • URL
    https://app.mcpjam.com/api/v1/projects/{projectId}/swarms
  • Auth
    HTTP bearer

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

  • 561e4fd0dfa2Revision changes
    • info

      added the new optional request property

    • info

      added subschema #1 subschema #2 to the request body oneOf list

    • info

      the request property became optional

    • info

      request property deprecated

    • info

      response property sessionsPerTarget deprecated

    • info

      added the required property to the response with the status

  • bc9863625ac8Revision changes
    • info

      added the optional property to the response with the status