Skip to main content
POST
/
v1
/
swarm
/
completions
{
  "job_id": "<string>",
  "status": "<string>",
  "swarm_name": "<string>",
  "description": "<string>",
  "swarm_type": "<string>",
  "output": "<any>",
  "number_of_agents": 123,
  "service_tier": "<string>",
  "execution_time": 123,
  "usage": {}
}

Headers

​
x-api-key
string
required

Body

application/json
​
name
string | null
Maximum length: 100
​
description
string | null
​
agents
AgentSpec · object[] | null
​
max_loops
integer | null
default:1
​
swarm_type
enum<string> | null
Available options:
AgentRearrange,
MixtureOfAgents,
SequentialWorkflow,
ConcurrentWorkflow,
GroupChat,
MultiAgentRouter,
AutoSwarmBuilder,
HiearchicalSwarm,
auto,
MajorityVoting,
MALT,
DeepResearchSwarm,
CouncilAsAJudge,
InteractiveGroupChat,
HeavySwarm,
LLMCouncil
​
rearrange_flow
string | null
​
task
string | null
​
img
string | null
​
rules
string | null
​
tasks
string[] | null
​
messages
​
stream
boolean | null
default:false
​
service_tier
string | null
default:standard
​
heavy_swarm_loops_per_agent
integer | null
default:1
​
heavy_swarm_question_agent_model_name
string | null
default:gpt-4.1
​
heavy_swarm_worker_model_name
string | null
default:claude-sonnet-4-20250514

Response

​
job_id
string | null
required
​
status
string | null
required
​
swarm_name
string | null
required
​
description
string | null
required
​
swarm_type
string | null
required
​
output
any
required
​
number_of_agents
integer | null
required
​
service_tier
string | null
required
​
execution_time
number | null
required
​
usage
object | null
required