Overview

The Swarm API stores multi-agent swarm configurations as orchestrator-type agents and tracks their executions through the workflow executions table. A swarm defines a set of participating agents and a maximum round count; executing a swarm creates a running execution record.

Base URL

For local development:

Authentication

All requests require a valid bearer token in the Authorization header. See Authentication for details.

Swarm object

Execution object

Endpoints

List swarms

Response

Create swarm

Request body

Response

Execute swarm

Response

Get execution

Response

Swarm health

Response

Error codes