Skip to main content
Install the native Python client and its compatibility adapters from PyPI:
Client() automatically uses the credential saved by runcloud login. For automation, set RUN_CLOUD_API_KEY and optionally RUN_CLOUD_API_URL, or pass api_key and api_url directly. The client also accepts RUN_CLOUD_API_TOKEN as an alias for RUN_CLOUD_API_KEY.

Name a sandbox

A name is a label you choose, and the filter list(name=...) matches on it server-side. Renaming is how a sandbox gets re-tagged without destroying it:
Renaming works in every state except destroyed, names are capped at 128 characters, and they are not unique — check state on a match before using it.

Compatibility adapters

The adapters cover core creation, lookup, commands, lifecycle, and destruction. Blaxel’s current SandboxInstance API is async; use SyncSandboxInstance when migrating its synchronous API. Provider-specific functionality without a public run.cloud equivalent raises UnsupportedCompatibilityFeatureError with a migration hint. The adapters do not report a fabricated success for unsupported features.