Skip to main content

list_runners

Source: src/cwsandbox/_discovery.py:289
List available runners, optionally filtered. Parameters
  • auth (AuthConfig | None): Authentication strategy, resolved headers, or provider for this request.
  • runner_group_id (str | None): Restrict results to this runner group.
  • gpu_type (str | None): Only return runners that support this GPU type.
  • architecture (str | None): Only return runners that support this CPU architecture.
  • healthy_only (bool): Only return healthy runners.
  • include_resources (bool): If True, include live resource availability.
  • min_available_cpu_millicores (int | None): Client-side filter on unreserved CPU.
  • min_available_memory_bytes (int | None): Client-side filter on unreserved memory.
  • min_available_gpu_count (int | None): Client-side filter on unreserved GPUs.
  • service_visibility (str | None): Require a runner that can enforce this typed visibility (public / private / custom).
Returns
  • list[Runner]: List of Runner objects matching the filters.

get_runner

Source: src/cwsandbox/_discovery.py:390
Get a single runner by (organization_id, runner_id). Always returns full details including resource availability when owned. Parameters
  • runner_id (str): Runner identifier (not globally unique alone).
  • organization_id (str): Organization that owns the runner.
  • auth (AuthConfig | None): Authentication strategy, resolved headers, or provider for this request.
Returns
  • Runner: Runner with full details.

format_bytes

Source: src/cwsandbox/_discovery.py:39

Format bytes as a human-readable string using binary units.

format_cpu

Source: src/cwsandbox/_discovery.py:54

Format CPU millicores as a human-readable string.

Last modified on September 17, 2026