Skip to content
Hexel StudioDocs

Start a swarm

POST/harness/swarms

Headers

Bearer <token>. A Hexel Studio access token for your organization.

The workspace the request acts in (ws_...). It never grants access by itself.

The environment the request acts in (env_...). It never grants access by itself.

Body parameters

patternstring

One of: "map", "lead_workers", "pipeline", "board"

goalstring
agentstring
worker_agentoptional string
itemsoptional array of any

A map's items.

inputsoptional object
reduceoptional ReduceStep
stagesoptional array of PipelineStageInput

A pipeline's stages.

boardoptional BoardSettings
accessoptional object
budgetoptional object
member_budgetoptional Budget

What a task may spend; it narrows the agent's own budgets. max_estimate_usd is accepted on create only.

max_concurrencyoptional integerint32
failure_ruleoptional FailureRule
sandbox_templateoptional string

Returns

201The swarm.Swarm

agentstring
boardoptional any

Any JSON value.

Any JSON value.

capabilitiesarray of string
created_atstringdate-time
end_reasonoptional string
failure_ruleFailureRule
goalstring
goal_digestoptional string
idstring
max_concurrencyintegerint32

Any JSON value.

org_idstring
outputsoptional any

Any JSON value.

patternstring

One of: "map", "lead_workers", "pipeline", "board"

progressSwarmProgress
reduceoptional any

Any JSON value.

sandbox_templateoptional string
stagesoptional any

Any JSON value.

statestring

One of: "running", "waiting", "succeeded", "failed", "cancelled"

updated_atstringdate-time
waiting_reasonoptional string
worker_agentoptional string

Errors

  • default