Skip to main content
POST
Create a swarm

Authorizations

Authorization
string
header
required

MCPJam API key (sk_…). Create one at Settings → API keys. Guest sessions cannot use the API, and API keys cannot manage other API keys.

Headers

Idempotency-Key
string

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.

Path Parameters

projectId
string
required

ID of the hosted project that contains the server.

Body

application/json

The swarm to create.

name
string
required
Maximum string length: 200
sessionsPerTarget
integer
required
Required range: 1 <= x <= 100
maxTurns
integer
required
Required range: 1 <= x <= 200
description
string
Maximum string length: 2000
environmentIds
string[]
Minimum array length: 1

Response

The created swarm.

An authoring container for journeys. It holds DEFAULTS, not execution state — launching happens per journey.

id
string
required
projectId
string
required
name
string
required
description
string | null
required
environmentIds
string[]
required

Default fan-out for journeys authored under this container.

sessionsPerTarget
integer | null
required
maxTurns
integer | null
required
createdAt
number
required

Epoch milliseconds.

updatedAt
number
required

Epoch milliseconds.