Download swarm results

GET

swarms

{id}

results

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

# swarm is returned by Swarm.run.
for result in swarm:
    print(result)

// swarm is returned by Swarm.run.
for await (const result of swarm) {
  console.log(result);
}

{
  "index": 123,
  "input": "<any>",
  "state": "<string>",
  "attempt": 123,
  "sandbox_id": "<string>",
  "exit_code": {},
  "stdout": "<string>",
  "stderr": "<string>",
  "stdout_truncated": true,
  "stderr_truncated": true,
  "boot_ms": {},
  "queue_ms": {},
  "execution_ms": {},
  "duration_ms": {},
  "started_at_ms": {},
  "completed_at_ms": {},
  "error": "<string>",
  "files": {
    "entries": [
      {
        "path": "<string>",
        "encoding": "<string>",
        "data": "<string>",
        "truncated": true,
        "error": "<string>"
      }
    ],
    "truncated": true
  },
  "create_failure": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    }
  },
  "attempt_failure": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    }
  },
  "execution_failure": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    },
    "protocol": "<string>",
    "truncated": true,
    "incomplete": true
  },
  "cleanup_failure": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    }
  },
  "placement_failure": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    }
  },
  "files_error": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    },
    "protocol": "<string>",
    "truncated": true,
    "incomplete": true
  },
  "stdout_encoding": "<string>",
  "stderr_encoding": "<string>",
  "files_ms": 123,
  "terminal_reason": "<string>",
  "stdout_bytes": 123,
  "stderr_bytes": 123,
  "total_bytes": 123,
  "complete": true,
  "truncated": true
}

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/results" \
  --header "X-API-Key: $BEAD_API_KEY"

# swarm is returned by Swarm.run.
for result in swarm:
    print(result)

// swarm is returned by Swarm.run.
for await (const result of swarm) {
  console.log(result);
}

Response

200

Terminal results as application/x-ndjson; each line is one selected member attempt.

integer

required

Zero-based member index.

any

required

JSON input assigned to this member.

string

required

Selected attempt state.

integer

required

Zero-based selected attempt number.

string

required

Machine used for this attempt.

integer | null

required

Process exit code; null means no confirmed command exit. May be null.

string

required

Captured standard output, bounded to 64 KiB.

string

required

Captured standard error, bounded to 64 KiB.

boolean

Whether standard output was incomplete.

boolean

Whether standard error was incomplete.

integer | null

required

Time from activation to command start in milliseconds. May be null.

integer | null

required

Time from job creation to activation in milliseconds. May be null.

integer | null

required

Command execution time in milliseconds. May be null.

integer | null

required

Time from job creation to attempt completion in milliseconds. May be null.

integer | null

required

Command start time in Unix milliseconds. May be null.

integer | null

required

Attempt completion time in Unix milliseconds. May be null.

string

Failure message when execution or cleanup failed.

object

Bounded artifact collection.

Show Properties

object[]

required

At most 16 matching regular files and 32 KiB of file bytes.

Show Properties

string

required

Absolute machine path of the selected file.

string

File bytes are base64 encoded. Allowed values: "base64".

string

Base64-encoded file bytes.

boolean

Whether this file exceeded the remaining byte budget.

string

Read failure such as unreadable; present instead of bytes.

boolean

required

Whether the file count, traversal, or byte limit stopped collection.

object

Machine creation failure.

Show Properties

integer

required

HTTP status returned by the failed operation.

object

required

Request failure.

Show Properties

integer

required

HTTP status code.

string

required

Explanation of the failed request.

string

Stable error identifier when supplied; use it to decide how to recover.

object

The resource limit that blocked the request.

Show Properties

string

required

Name of the exhausted resource.

integer

required

Allowed amount of this resource.

integer

required

Current usage counted against the limit.

string

required

Action you can take to proceed.

integer

Unix time in seconds when this time window resets.

object

Failure while preparing the attempt.

Show Properties

integer

required

HTTP status returned by the failed operation.

object

required

Request failure.

Show Properties

integer

required

HTTP status code.

string

required

Explanation of the failed request.

string

Stable error identifier when supplied; use it to decide how to recover.

object

The resource limit that blocked the request.

Show Properties

string

required

Name of the exhausted resource.

integer

required

Allowed amount of this resource.

integer

required

Current usage counted against the limit.

string

required

Action you can take to proceed.

integer

Unix time in seconds when this time window resets.

object

Command transport or execution failure.

Show Properties

integer

required

HTTP status returned by the failed operation.

object

required

Request failure.

Show Properties

integer

required

HTTP status code.

string

required

Explanation of the failed request.

string

Stable error identifier when supplied; use it to decide how to recover.

object

The resource limit that blocked the request.

Show Properties

string

required

Name of the exhausted resource.

integer

required

Allowed amount of this resource.

integer

required

Current usage counted against the limit.

string

required

Action you can take to proceed.

integer

Unix time in seconds when this time window resets.

string

Failed transport protocol when wire evidence is available.

boolean

Whether failure details exceeded the error byte limit.

boolean

Whether the failure response was interrupted.

object

Failure while deleting the machine.

Show Properties

integer

required

HTTP status returned by the failed operation.

object

required

Request failure.

Show Properties

integer

required

HTTP status code.

string

required

Explanation of the failed request.

string

Stable error identifier when supplied; use it to decide how to recover.

object

The resource limit that blocked the request.

Show Properties

string

required

Name of the exhausted resource.

integer

required

Allowed amount of this resource.

integer

required

Current usage counted against the limit.

string

required

Action you can take to proceed.

integer

Unix time in seconds when this time window resets.

object

Capacity limit encountered while waiting to start.

Show Properties

integer

required

HTTP status returned by the failed operation.

object

required

Request failure.

Show Properties

integer

required

HTTP status code.

string

required

Explanation of the failed request.

string

Stable error identifier when supplied; use it to decide how to recover.

object

The resource limit that blocked the request.

Show Properties

string

required

Name of the exhausted resource.

integer

required

Allowed amount of this resource.

integer

required

Current usage counted against the limit.

string

required

Action you can take to proceed.

integer

Unix time in seconds when this time window resets.

object

Artifact collection failure; command exit evidence is preserved.

Show Properties

integer

HTTP status returned by collection.

object

Request failure.

Show Properties

integer

required

HTTP status code.

string

required

Explanation of the failed request.

string

Stable error identifier when supplied; use it to decide how to recover.

object

The resource limit that blocked the request.

Show Properties

string

required

Name of the exhausted resource.

integer

required

Allowed amount of this resource.

integer

required

Current usage counted against the limit.

string

required

Action you can take to proceed.

integer

Unix time in seconds when this time window resets.

string

Failed transport protocol when wire evidence is available.

boolean

Whether failure details exceeded the error byte limit.

boolean

Whether the failure response was interrupted.

string

Encoding of captured standard output, such as utf-8 or base64.

string

Encoding of captured standard error, such as utf-8 or base64.

integer

Artifact collection duration in milliseconds, when collected.

string

Why an unstarted member terminated, such as job deadline exceeded.

integer

Observed standard output bytes before truncation.

integer

Observed standard error bytes before truncation.

integer

Combined observed output bytes.

boolean

Whether a terminal command frame confirmed the captured output.

boolean

Whether the captured evidence is incomplete or byte-limited.

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.
409	The swarm is queued or running; poll status until cleanup reaches a terminal state.
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/results" \
  --header "X-API-Key: $BEAD_API_KEY"

# swarm is returned by Swarm.run.
for result in swarm:
    print(result)

// swarm is returned by Swarm.run.
for await (const result of swarm) {
  console.log(result);
}

{
  "index": 123,
  "input": "<any>",
  "state": "<string>",
  "attempt": 123,
  "sandbox_id": "<string>",
  "exit_code": {},
  "stdout": "<string>",
  "stderr": "<string>",
  "stdout_truncated": true,
  "stderr_truncated": true,
  "boot_ms": {},
  "queue_ms": {},
  "execution_ms": {},
  "duration_ms": {},
  "started_at_ms": {},
  "completed_at_ms": {},
  "error": "<string>",
  "files": {
    "entries": [
      {
        "path": "<string>",
        "encoding": "<string>",
        "data": "<string>",
        "truncated": true,
        "error": "<string>"
      }
    ],
    "truncated": true
  },
  "create_failure": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    }
  },
  "attempt_failure": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    }
  },
  "execution_failure": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    },
    "protocol": "<string>",
    "truncated": true,
    "incomplete": true
  },
  "cleanup_failure": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    }
  },
  "placement_failure": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    }
  },
  "files_error": {
    "status": 123,
    "response": {
      "code": 123,
      "message": "<string>",
      "error_code": "<string>",
      "limit": {
        "limit": "<string>",
        "maximum": 123,
        "usage": 123,
        "next_action": "<string>",
        "reset_at": 123
      }
    },
    "protocol": "<string>",
    "truncated": true,
    "incomplete": true
  },
  "stdout_encoding": "<string>",
  "stderr_encoding": "<string>",
  "files_ms": 123,
  "terminal_reason": "<string>",
  "stdout_bytes": 123,
  "stderr_bytes": 123,
  "total_bytes": 123,
  "complete": true,
  "truncated": true
}

Start here

Endpoints

Download swarm results

Authentication

Parameters

Response

200

Errors

​Authentication

​Parameters

​Response

​200

​Errors

Authentication

Parameters

Response

200

Errors