Functions

Documentation Index

Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt

Use this file to discover all available pages before exploring further.

​

list_runners

list_runners(*, runner_group_id: str | None = None, profile_name: str | None = None, gpu_type: str | None = None, architecture: str | None = None, include_resources: bool = False, min_available_cpu_millicores: int | None = None, min_available_memory_bytes: int | None = None, min_available_gpu_count: int | None = None, ingress_mode: str | None = None, egress_mode: str | None = None) -> list[Runner]

• runner_group_id (str | None): Restrict results to this runner group.
• profile_name (str | None): Only return runners that have this profile.
• gpu_type (str | None): Only return runners that support this GPU type.
• architecture (str | None): Only return runners that support this CPU architecture.
• include_resources (bool): If True, include live resource availability on each runner. Defaults to False (basic view).
• min_available_cpu_millicores (int | None): Only return runners with at least this many unreserved CPU millicores. Automatically enables include_resources. Filtered client-side.
• min_available_memory_bytes (int | None): Only return runners with at least this many unreserved memory bytes. Automatically enables include_resources. Filtered client-side.
• min_available_gpu_count (int | None): Only return runners with at least this many unreserved GPUs. Automatically enables include_resources. Filtered client-side.
• ingress_mode (str | None): Only return runners whose profiles support this ingress mode. Requires an additional profile fetch. Filtered client-side.
• egress_mode (str | None): Only return runners whose profiles support this egress mode. Requires an additional profile fetch. Filtered client-side.

• list[Runner]: List of Runner objects matching the filters.

• CWSandboxAuthenticationError: If credentials are invalid.
• CWSandboxError: On network or service errors.

​

get_runner

get_runner(runner_id: str) -> Runner

• runner_id (str): Unique identifier of the runner.

• Runner: Runner with full details.

• ValueError: If runner_id is empty.
• RunnerNotFoundError: If no runner exists with the given ID.
• CWSandboxAuthenticationError: If credentials are invalid.
• CWSandboxError: On network or service errors.

​

list_profiles

list_profiles(*, gpu_type: str | None = None, architecture: str | None = None, runner_id: str | None = None, ingress_mode: str | None = None, egress_mode: str | None = None) -> list[Profile]

• gpu_type (str | None): Only return profiles that support this GPU type.
• architecture (str | None): Only return profiles that support this CPU architecture.
• runner_id (str | None): Only return profiles belonging to this runner.
• ingress_mode (str | None): Only return profiles that support this ingress mode. Filtered client-side after fetching results from the backend.
• egress_mode (str | None): Only return profiles that support this egress mode. Filtered client-side after fetching results from the backend.

• list[Profile]: List of Profile objects matching the filters.

• CWSandboxAuthenticationError: If credentials are invalid.
• CWSandboxError: On network or service errors.

​

get_profile

get_profile(profile_name: str, *, runner_id: str | None = None) -> Profile

• profile_name (str): Name of the profile to retrieve.
• runner_id (str | None): Optionally scope the lookup to a specific runner.

• Profile: Profile matching the given name.

• ValueError: If profile_name is empty.
• ProfileNotFoundError: If no matching profile is found.
• CWSandboxAuthenticationError: If credentials are invalid.
• CWSandboxError: On network or service errors.

​

format_bytes

format_bytes(value: int) -> str

• value (int): Number of bytes.

• str: Human-readable string with appropriate unit.

>>> format_bytes(17179869184)
'16.0 GiB'
>>> format_bytes(0)
'0 B'

​

format_cpu

format_cpu(millicores: int) -> str

• millicores (int): CPU capacity in millicores.

• str: Human-readable string in cores.

>>> format_cpu(4000)
'4.0 vCPU'
>>> format_cpu(500)
'0.5 vCPU'