For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Guides SDK Recipes API Reference Integrations Compare Changelog

API Reference

API Reference Swarms

Cancel a swarm

POST

https://api.recursiv.io/api/v1/swarms/:id/cancel

POST

/api/v1/swarms/:id/cancel

$ curl -X POST https://api.recursiv.io/api/v1/swarms/id/cancel \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": {
3     "id": "string",
4     "name": "string",
5     "goal": "string",
6     "coordinatorId": "string",
7     "status": "string",
8     "config": {},
9     "summary": "string",
10     "members": [
11       {
12         "id": "string",
13         "swarmId": "string",
14         "agentId": "string",
15         "role": "string",
16         "joinedAt": "2024-01-15T09:30:00Z"
17       }
18     ],
19     "createdAt": "2024-01-15T09:30:00Z",
20     "updatedAt": "2024-01-15T09:30:00Z"
21   }
22 }

Path parameters

idstringRequired

Response

Cancelled swarm

dataobjectOptional

Errors

401

Unauthorized Error

404

Not Found Error

Was this page helpful?

Complete a swarm