Get swarm progress

GET

swarms

{id}

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

# swarm is returned by Swarm.run.
print(swarm.status())

// swarm is returned by Swarm.run.
console.log(await swarm.status());

{
  "id": "<string>",
  "state": "<string>",
  "counts": {
    "pending": 123,
    "running": 123,
    "succeeded": 123,
    "failed": 123,
    "cancelled": 123
  },
  "created_at_ms": 123,
  "completed_at_ms": {},
  "results_url": "<string>",
  "retention_seconds": 123
}

Authentication

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

Parameters

string

required

UUID of the swarm job. Format: uuid.

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

# swarm is returned by Swarm.run.
print(swarm.status())

// swarm is returned by Swarm.run.
console.log(await swarm.status());

Response

200

Swarm state and member counts.

string

required

Swarm UUID.

string

required

Job state after scheduling and cleanup. Allowed values: "queued", "running", "completed", "failed", "cancelled".

object

required

Member counts grouped by current result.

Show Properties

integer

required

Members waiting to start.

integer

required

Members executing or cleaning up.

integer

required

Members with a successful attempt.

integer

required

Members whose attempts failed.

integer

required

Members cancelled before success.

integer

required

Creation time in Unix milliseconds.

integer | null

required

Completion time in Unix milliseconds; null while active. May be null.

string

required

Relative URL for the terminal JSONL results download.

integer

required

Seconds results remain available after completion. Allowed values: 86400.

Errors

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`). Follow limit.next_action and Retry-After when present.
503	Service or persistence is temporarily unavailable.

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

# swarm is returned by Swarm.run.
print(swarm.status())

// swarm is returned by Swarm.run.
console.log(await swarm.status());

{
  "id": "<string>",
  "state": "<string>",
  "counts": {
    "pending": 123,
    "running": 123,
    "succeeded": 123,
    "failed": 123,
    "cancelled": 123
  },
  "created_at_ms": 123,
  "completed_at_ms": {},
  "results_url": "<string>",
  "retention_seconds": 123
}

Start here

Endpoints

Get swarm progress

Authentication

Parameters

Response

200

Errors

​Authentication

​Parameters

​Response

​200

​Errors

Authentication

Parameters

Response

200

Errors