Cancel a swarm

POST

swarms

{id}

cancel

curl --request POST \
  --url "https://api.bead.run/swarms/$SWARM_ID/cancel" \
  --header "X-API-Key: $BEAD_API_KEY"

# swarm is returned by Swarm.run.
swarm.cancel()

// swarm is returned by Swarm.run.
await swarm.cancel();

{
  "id": "<string>",
  "cancellation_requested": true
}

Authentication

Send your scoped bearer token in the Authorization: Bearer <BEAD_TOKEN> header, or send your API key in X-API-Key.

string

required

UUID of the swarm job. Format: uuid.

curl --request POST \
  --url "https://api.bead.run/swarms/$SWARM_ID/cancel" \
  --header "X-API-Key: $BEAD_API_KEY"

# swarm is returned by Swarm.run.
swarm.cancel()

// swarm is returned by Swarm.run.
await swarm.cancel();

Cancellation requested; poll status until terminal cleanup completes.

string

required

Swarm UUID.

boolean

required

True after cancellation has been requested.

Status	Meaning
400	Invalid resource UUID or request parameters.
401	Authentication credential is missing or rejected.
403	The credential lacks the required scope.
404	The requested resource does not exist or is outside your organization.
429	Request or resource admission limit exceeded (`admission_limit`; trial capacity can return `free_capacity_full`). Follow limit.next_action and Retry-After when present.
503	Service or persistence is temporarily unavailable.

curl --request POST \
  --url "https://api.bead.run/swarms/$SWARM_ID/cancel" \
  --header "X-API-Key: $BEAD_API_KEY"

# swarm is returned by Swarm.run.
swarm.cancel()

// swarm is returned by Swarm.run.
await swarm.cancel();

{
  "id": "<string>",
  "cancellation_requested": true
}