Types

How the SDK types map to each language, and every object, record, enum and function in one list.

Tables on these pages use one neutral notation for types (the Rust spelling). This page maps it to each language and lists the items of the SDK.

Type notation#

Notation	Python	TypeScript	Swift	Kotlin	Rust
`String`	`str`	`string`	`String`	`String`	`String`
`bool`	`bool`	`boolean`	`Bool`	`Boolean`	`bool`
`u32`	`int`	`number`	`UInt32`	`UInt`	`u32`
`i64`	`int`	`bigint`	`Int64`	`Long`	`i64`
`u64`	`int`	`bigint`	`UInt64`	`ULong`	`u64`
`f64`	`float`	`number`	`Double`	`Double`	`f64`
`Vec<u8>`	`bytes`	`ArrayBuffer`	`Data`	`ByteArray`	`Vec<u8>`
`Vec<T>`	`List[T]`	`Array<T>`	`[T]`	`List<T>`	`Vec<T>`
`Option<T>`	`Optional[T]`	`T \| undefined`	`T?`	`T?`	`Option<T>`
`HashMap<K, V>`	`dict[K, V]`	`Map<K, V>`	`[K: V]`	`Map<K, V>`	`HashMap<K, V>`
`SystemTime`	`datetime.datetime`	`Date`	`Date`	`java.time.Instant`	`SystemTime`
`Duration`	`datetime.timedelta`	`number`	`TimeInterval`	`java.time.Duration`	`Duration`
`Sandbox (an object)`	`Sandbox`	`SandboxLike`	`Sandbox`	`Sandbox`	`Arc<Sandbox>`

Option<T> may be absent: None, undefined, nil, null. A default of None means the argument or field can be left out.

Names in each language#

	Python	TypeScript	Swift	Kotlin	Rust
Import	`import cua`	`import { ... } from '@trycua/cua'`	`import Cua`	`import ai.cua.sdk.*`	`use cua_sdk::*;`
Methods, arguments, fields	`snake_case`	`camelCase`	`camelCase`	`camelCase`	`snake_case`
Enum variants	`UPPER_SNAKE`	`PascalCase`	`lowerCamel`	`UPPER_SNAKE` (plain), `PascalCase` (with fields)	`PascalCase`
Async methods	`async def`, awaited	return a `Promise`, optional `{ signal }`	`async`	`suspend`	`async fn`
Errors	`CuaError.<Variant>`	`CuaError.<Variant>`	`CuaError.<Variant>(message:)`	`CuaException.<Variant>`	`CuaError::<Variant>(String)`
Object handles	the class	the class; arguments and results use the `<Name>Like` interface	the class	the class	`Arc<T>`
Optional arguments	positional (`sb.spacesd(None)`)	`undefined`	`nil`	`null`	`None`

Renamed members: in Kotlin, objects implement AutoCloseable, whose close() frees the handle, so the async close is renamed (McpClient.closeClient, MediaSession.closeSession, PortForward.closeForward, SpaceStreamSession.closeStream). In TypeScript, reserved words get a trailing underscore (Sandbox.delete_()). The signature tabs show the renamed form.

All items#

290 items. Methods are listed on their object.

The 669 items of the Cua Spaces app export (source-available, FSL-1.1-MIT, Swift only) are listed on their pages: Decoded media, Host teleport, Teleport an app, Spaces app core, App core: Cua Volume storage, mount and sync, App core: agents, drive, notifications.

Item	Kind	Summary
`agent_event_category`	function	The category of an event kind: `message`, `user`, `activity` or `hidden` (the rule `AgentEvent.category` and `AgentTranscript` use).
`agent_harnesses`	function	The harnesses, their readiness, installs, key variables and limits, as JSON.
`AgentActionReport`	record	Result of `Space.agent_message` / `Space.agent_stop`.
`AgentArtifact`	record	A file the run created or changed.
`AgentDelivery`	record	What `Spaces.persistent_agent_send` did.
`AgentEvent`	record	One normalized event.
`AgentEventPage`	record	A page of events.
`AgentFile`	record	A file for the first prompt or a follow-up.
`AgentInfo`	record	One AI coding agent and what cua configured for it.
`AgentMcpServer`	record	The MCP server to register.
`AgentPauseReport`	record	What `Spaces.agent_pause` did.
`AgentResumeReport`	record	What `Spaces.agent_resume` did.
`AgentRun`	object	One run.
`AgentRunInfo`	record	A run's state.
`AgentRunMcpServer`	record	An MCP server a run's agent gets: `url` (streamable HTTP, as reachable from inside the sandbox) or `command` (stdio, run in the sandbox).
`AgentRunOptions`	record	Options for `Agents.run`.
`AgentRunResult`	record	What the last turn produced.
`AgentRunStatus`	record	One agent run's status.
`Agents`	object	Agent runs in one sandbox.
`AgentSetup`	object	Agent onboarding for this machine's user.
`AgentSetupChange`	enum	What happened to one target.
`AgentSetupOutcome`	record	One target's outcome.
`AgentSetupTarget`	enum	What an operation touched.
`AgentStartReport`	record	Result of `Space.agent_start`.
`AgentTranscript`	object	A run's events folded into conversation items, the same rule in every language: the agent's message chunks join into `message` items, the prompt is a `user` item (never repeated as agent text), and consecutive activity of one turn folds into one `activity` group.
`AgentTranscriptItem`	record	One item of an `AgentTranscript`.
`ambiguous_sandbox_candidates`	function	The qualified candidates an `AmbiguousSandbox` message lists (empty for any other message).
`AudioPacket`	record	One audio packet (MEDIA.md §12.2).
`AudioSink`	object	Receives audio packets.
`Auth`	object	Sign-in and the shared session.
`AuthIdentity`	record	Who is signed in (from token claims; display only).
`AuthStatus`	record	The stored session, read without network access.
`BuildFile`	record	A local file copied into a built image.
`BundledSkill`	record	A skill bundled with the SDK.
`canonical_image`	function	The canonical image for `os` (`linux`, `windows`, `macos`) and `version` (`None` = default: `ghcr.io/trycua/linux:24.04`, `ghcr.io/trycua/windows:2022`, `ghcr.io/trycua/macos:26`; macOS accepts `tahoe`/`sequoia`).
`canonical_image_tier`	function	The canonical image for `os`, `version` and `tier`: `slim` (the minimum that passes `cua-spacesd doctor --strict`; CI and benchmarks use it), `full` or `None` (the default, with dev tooling) or, on macOS, `xcode` / `xcode-<X.Y>` (full plus one pinned Xcode).
`check_placement`	function	Checks a location, kind and runtime against each other without creating anything: `InvalidPlacement` (listing the valid values) when the combination does not exist.
`CloudCheck`	record	One check `cloud_test` ran.
`CloudConnected`	record	`cloud_connect`: the connected cloud and the checks it passed.
`CloudCredentials`	record	Where a cloud's credentials were found on this machine (never a secret).
`CloudDisconnected`	record	`cloud_disconnect`.
`CloudKind`	record	What a cloud can run for one image family, and the estimated cost.
`CloudOptions`	record	Advanced options for cloud sandboxes (warm capacity, limits, TTL, a dedicated pool).
`CloudProvider`	record	One cloud as `cloud_status` lists it.
`CloudResource`	record	One thing Cua created in a cloud.
`CloudStatus`	record	`cloud_status`.
`CloudSweepItem`	record	One row of `cloud_sweep`.
`CloudSweepReport`	record	`cloud_sweep`.
`CloudTarget`	record	Where in a cloud account Spaces go.
`CloudTestReport`	record	`cloud_test`.
`ComputerGrant`	record	A persistent agent's grant on one of the user's computers.
`config_get`	function	One setting's effective value and source.
`config_list`	function	Every setting with its effective value and source.
`config_path`	function	The config file's path (`$CUA_HOME/config.toml`).
`config_set`	function	Writes a setting to the config file (checked and normalised: `default.on` takes `local`, `cloud` or a provider).
`config_unset`	function	Removes a setting from the config file.
`ConfigEntry`	record	One setting's effective value.
`Container`	record	An extra container next to a sandbox (a compose-style sidecar), addressed by name on every runtime: the sandbox reaches it at its `name` (on its `ports`), it reaches the sandbox at `main`, and `services` may name its ports (`{"db": 5432}`).
`contrib_providers_built`	function	The contrib providers this build includes (empty unless built with the `contrib` feature).
`Cua`	object	The entry point of the SDK: create one with `Cua::embedded` or `Cua::connect`, then reach sandboxes, Fleet, Spaces and the rest through its accessors.
`cua_sdk_version`	function	Version of the SDK library.
`CuaConfig`	record	Configuration of an embedded SDK runtime.
`CuaError`	error	Every error the SDK raises.
`CuaInfo`	record	Identity of the SDK (and daemon, when connected).
`CuaMode`	enum	Where the SDK runtime lives.
`CursorArt`	record	One cursor shape's shared art: an SVG path on a square canvas, filled with the participant's color over an outline.
`DeviceEnrollment`	record	`Devices.enroll`'s result.
`Devices`	object	This device as a client of the signed-in account on a relay: its enrollment, the account's other devices and its audit log.
`DevicesSnapshot`	record	Everything the Devices page reads, in one call.
`DoctorReport`	record	Doctor output.
`DriveAccessRequest`	record	An agent's request for more access, waiting for the user.
`DriveAudit`	record	The newest audit events and whether the hash chain verified.
`DriveAuditEvent`	record	One audit event.
`DriveCacheStats`	record	The block cache in front of a remote store.
`DriveConflict`	record	A write that lost to a later one, kept in history and as a copy.
`DriveDevice`	record	A device sharing the drive's bucket.
`DriveEntry`	record	One row of a drive listing.
`DriveFile`	record	A file's content and version.
`DriveFileSync`	record	One file's sync state.
`DriveGrant`	record	A widening of an agent's or a Space's access.
`DriveListing`	record	A folder's listing.
`DriveMountStatus`	record	The drive as a volume.
`DriveObject`	record	A written version.
`DrivePendingUpload`	record	A file waiting to upload.
`DriveS3Settings`	record	Where an S3-compatible bucket is (no keys).
`DriveSpaceVolume`	record	The volume mounted in a Space's guest.
`DriveStorage`	record	Where the drive keeps its bytes (Settings > Storage).
`DriveStorageCheck`	record	What a storage test found.
`DriveStorageUpdate`	record	A storage change, or with `dry_run` a connection test.
`DriveSyncEvent`	record	One sync event.
`DriveSyncEvents`	record	Events after a sequence number, and the sequence to ask after next.
`DriveSyncStatus`	record	Sync across devices.
`DriveVersion`	record	One version in a file's history.
`DriveView`	record	Whose view of the drive a call takes: the user (the default, the whole drive) or a persistent agent in a Space.
`error_doc_url`	function	A link to the errors-reference entry of a `CuaError` variant, by name (`InvalidArgument`, case-insensitive).
`ExitInfo`	record	How a process ended.
`FileEntry`	record	A file or directory in the guest.
`Fleet`	object	Fleet control plane.
`fleet_check_runtime`	function	`fleet_resolve_runtime` with the image variant already known (`variant` as `fleet_image_variant` returns it); `None` means the manifest could not be read (an unset runtime then falls back to the reference).
`fleet_generate_claim_token`	function	A fresh per-claim env token (64 hex characters).
`fleet_image_variant`	function	The variant of an image from its registry documents (`manifest`: an image manifest or index, `config`: the platform manifest's config blob): `container-disk`, `rootfs` or `other`.
`fleet_resolve_runtime`	function	The Fleet runtime for `image`: `runtime` (`kubevirt`, `gvisor`) when given, else the one the image needs.
`fleet_size_limits`	function	The everyday sizes of a cloud sandbox (1-8 vCPUs, 1-32 GiB), which the Cua apps offer.
`FleetBillingCard`	record	The saved card (`Fleet.billing_status`): never its number.
`FleetBillingCredit`	record	The account's Cua Cloud credit.
`FleetBillingStatus`	record	The account's Cua Cloud billing (`GET /api/billing/status`).
`FleetClaim`	record	A claim.
`FleetClaimOptions`	record	Claim options for `Fleet.acquire_with`.
`FleetGcReport`	record	What a pool GC did.
`FleetManagedPool`	record	A managed pool (`cua-auto-`, or a legacy `cua-eph-`).
`FleetPool`	record	A pool.
`FleetPoolExport`	record	A pool read back as the shared model, plus its Terraform block.
`FleetPools`	object	Managed pools: what `Sandboxes.create` without a pool uses.
`FleetPoolSpec`	record	A warm pool spec (`Pool.apply` semantics: pool, namespace and template share `name`).
`FleetSandbox`	record	A bound sandbox.
`FleetSettings`	record	Fleet credentials and endpoints.
`FleetSignedUrl`	record	A signed, shareable service URL.
`FleetSizeLimits`	record	The everyday sizes of a cloud sandbox, which the Cua apps offer (`cua_fleet::CLOUD_DEFAULT_RANGE_CPUS`, `cua_fleet::CLOUD_DEFAULT_RANGE_MEMORY_MB`).
`FleetUsagePricing`	record	This account's Cua Cloud rates (`Fleet.usage_pricing`).
`FrameSink`	object	Receives video frames and control events.
`GpuOption`	record	One GPU option of a runtime (see `Spaces.gpu_support`).
`GpuSupport`	record	The GPU options of one runtime: empty, with the reason, when it has none.
`GuestDisplay`	object	The guest display of a sandbox without cua-spacesd (`Sandbox.guest_display`).
`HomeTransfer`	record	What moved between the drive and a Space.
`Host`	object	This machine as an unattended-access host.
`HostAccessRecord`	record	One access to this machine.
`HostPermission`	record	A macOS privacy pane the user must grant.
`HostProvidedSpace`	record	A Space this machine provides to one of your devices.
`HostSettingsChange`	record	A change to this machine's Spaces settings (`None` keeps a value).
`HostSetupOptions`	record	`cua host setup` options.
`HostSpacesAuditRecord`	record	One line of this machine's Spaces audit (remote creates, deletes, refusals and settings changes).
`HostStatus`	record	Host status.
`HttpHeader`	record	An HTTP header.
`HttpResponse`	record	An HTTP response from a sandbox service.
`image_alias`	function	The canonical image a CLI alias (`linux`, `windows`, `macos[:version]`, bare `ubuntu`) names, or `None` for a plain reference (`ubuntu:24.04` is Docker Hub's image).
`ImageBuild`	record	Image layers built on top of a sandbox's image.
`ImageFormat`	enum	Screenshot encoding.
`ImageInfo`	record	The image a sandbox runs, as resolved and pinned at create time.
`ImageLayer`	enum	One image build step (as in `images.cua.ai/v1alpha1` recipes).
`Local`	object	Local runtimes and images.
`LocalImage`	record	A local image.
`LocalStorage`	record	What local Spaces have room for (see `Local.storage`).
`LocationInfo`	record	The locations `on` accepts: `local`, `cloud`, then registered providers.
`locations`	function	Every location with the kinds and runtimes it offers (for pickers and help text).
`LoginAttempt`	object	A started sign-in.
`LoginMethod`	enum	How a sign-in proceeds.
`may_have_fleet_session`	function	Whether a `cua auth login` session may be stored, decided without reading the OS credential vault (the non-secret session marker, or the file store's file).
`mcp_connect`	function	Connects an MCP client to `config` (from `Sandbox.mcp_config`).
`mcp_connect_url`	function	Connects an MCP client to an endpoint URL (`http://host:8765/mcp`; a bare origin means `/mcp`) with `headers` on every request.
`McpClient`	object	An MCP client (rmcp, streamable HTTP; protocol 2026-07-28 when the server supports it, else the server's revision).
`McpConfig`	record	Where an MCP endpoint is and what every request needs.
`MediaBridge`	record	A media bridge for webviews (daemon mode).
`MediaEvent`	record	A control message (`hello`, `session_opened`, `lifecycle`, `audio_config`, `stats`, `error`, ...) or the close of the socket (`kind = "closed"`, `json = {"code":…, "reason":…}`).
`MediaOpenOptions`	record	Media session options.
`MediaSession`	object	A live media session.
`MediaStats`	record	Delivery counters.
`normalize_image`	function	Normalises a reference like the docker CLI (`python` is `docker.io/library/python:latest`).
`NotificationInfo`	record	One entry of the notifications feed.
`omarchy_image`	function	The Omarchy image, `ghcr.io/trycua/omarchy:<channel>` (default `edge`; also `rc`, `stable`): Omarchy (Arch Linux, Hyprland) with cua-spacesd, as an amd64 VM (QEMU locally, KubeVirt in the cloud; emulated on arm64 hosts).
`Overlay`	record	A binary to inject into a sandbox.
`OverlayResult`	record	What an overlay did.
`parse_sandbox_ref`	function	Parses a sandbox ref: `local:<name>`, `cloud:<name>`, `direct:<host:port>`, `relay:<machine-id>`, a legacy spelling (`space://fleet/<ns>/<claim>`, `fleet:<ns>:<claim>`, `url:<addr>`, a URL), or a bare name.
`PersistentAgentInfo`	record	A persistent agent: a named harness whose memory (its home in the Cua Drive) outlives its runs and its Space.
`PersistentAgentOptions`	record	How to create a persistent agent.
`Point`	record	A point.
`PoolOptions`	record	How a pool keeps capacity for a `SandboxSpec`.
`PortForward`	object	An active port forward.
`presence_color`	function	The stable presence color of an agent or other principal (`#rrggbb`): a cursor palette color picked by a hash of `id`.
`presence_conformance_json`	function	The presence conformance vectors (JSON), for binding test suites.
`presence_cursor_art`	function	The shared art for `shape` (unknown names give the arrow).
`presence_cursor_art_all`	function	The shared art for every shape.
`presence_cursor_art_svg`	function	A standalone SVG of `shape` in `color`, `size` pixels square.
`presence_now_ms`	function	The local clock `PresenceView` expects: Unix time in milliseconds.
`presence_text_color`	function	Black or white text (`#000000` / `#ffffff`), whichever reads better on `background` (`#rrggbb`).
`PresenceCursor`	record	A normalized cursor.
`PresenceDrawable`	record	One cursor to draw now (see `PresenceView.drawables`).
`PresenceEvent`	record	A presence event.
`PresenceIdentity`	record	Who joins presence.
`PresenceMember`	record	A roster entry.
`PresenceParticipant`	record	A presence participant.
`PresencePoint`	record	A normalized point.
`PresenceView`	object	The shared presence netcode model: who is present and what to draw, with remote cursors interpolated (render delay, Catmull-Rom, extrapolation cap), idle cursors faded, stale participants dropped and your own cursor at the local pointer (libs/cua/proto/PRESENCE.md section 4).
`ProcessEvent`	record	One output chunk or the exit.
`ProcessEventKind`	enum	Kind of a process event.
`ProcessOutput`	record	Collected output of a finished process.
`PtySize`	record	A PTY size.
`PublicUrl`	record	A shareable URL of a sandbox service that expires.
`qualify_sandbox_ref`	function	Qualifies `name` for a lookup: `local = true` narrows a bare name to `local:<name>`, `false` to `cloud:<name>`, `None` keeps it (a bare name is then searched across locations).
`ReadinessProbe`	record	A user-declared readiness probe.
`RegistrySecret`	enum	Credentials for a private registry image.
`Relay`	object	The signed-in account's view of a cua-relay.
`RelayAuditEvent`	record	One event of the account's audit log.
`RelayClientInfo`	record	Somebody connected to a machine through the relay.
`RelayDevice`	record	A client device of the account, as the relay lists it.
`RelayMachine`	record	A machine of the account's relay directory (`relay:<id>`).
`ReplayMode`	enum	Scrollback replay when attaching.
`resolve_image`	function	Resolves `reference` for `backend` (`auto`, `local`, `fleet`, `container`/`docker`/`gvisor`, `vm`/`qemu`/`kubevirt`, `lume`) on `arch` (`amd64`/`arm64`; `None` = this host, or amd64 for `fleet`).
`resolve_image_with_secret`	function	`resolve_image` for a private image: `secret` joins the head of the registry auth chain (it is read in this process and never cached or logged).
`ResolvedImage`	record	A reference resolved for a backend.
`RoutineInfo`	record	A routine: a recurring turn of a persistent agent, fired by the daemon.
`RuntimeCheck`	record	One doctor check (one backend).
`RuntimeCheckStatus`	enum	Status of one local runtime component.
`Sandbox`	object	A sandbox handle.
`sandbox_locations`	function	Every location word `on=` accepts, in display order: `local`, `cloud`, then the contrib providers (`e2b`, `daytona`, `modal`, ...) and your own clouds (`aws`, `gcp`).
`SandboxCreateOptions`	record	Options for `Sandboxes.create`.
`Sandboxes`	object	Creates, finds and manages sandboxes.
`SandboxInfo`	record	A sandbox as listed.
`SandboxListing`	record	A sandbox listing and what it left out.
`SandboxPhase`	enum	Portable lifecycle phase, the same words local and in the cloud.
`SandboxRefParts`	record	A parsed sandbox ref.
`SandboxSpec`	record	What a sandbox runs: the one model behind `Sandbox.create`, managed pools and `Fleet.apply`.
`SandboxStatus`	enum	Coarse lifecycle status.
`Screenshot`	record	A captured screenshot.
`ScreenshotOptions`	record	Screenshot options.
`Service`	object	A named service of a sandbox.
`ServiceEndpoint`	record	Where a sandbox service is reachable from this process.
`SetupStep`	record	One setup step.
`SiteLoginOptions`	record	Options for `Space.request_site_login`.
`SiteLoginReport`	record	What `Space.request_site_login` did.
`Space`	object	A connected Space.
`SpaceAgentOptions`	record	Options for `Space.agent_start` beyond the harness and prompt.
`SpaceAppIcon`	record	An app icon from `Space.app_icons`: the icon the guest desktop uses, normalized by the SDK's icon cache.
`SpaceAppIconRequest`	record	One window's app, for `Space.app_icons`.
`SpaceBashResult`	record	Output of `Space.bash`.
`SpaceCancelOutcome`	record	What `Spaces.cancel_create` did.
`SpaceCreateListener`	object	Receives `SpaceCreateProgress` while `Spaces.create_with_progress` runs, in order, ending with `ready`.
`SpaceCreateOptions`	record	Options for `Spaces.create`: the same location / kind / runtime model as sandboxes.
`SpaceCreateProgress`	record	What a Space create is doing (see `Spaces.create_with_progress`).
`SpaceCreateResult`	record	Result of `Spaces.create`.
`SpaceDisplay`	record	One of a Space's displays (`Space.displays`).
`SpaceHotspotStatus`	record	Hotspot state.
`SpaceInfo`	record	A registered Space.
`SpacePowerReport`	record	What `Spaces.stop` or `Spaces.start` did.
`SpacePresence`	object	A joined presence session.
`SpaceRelayRegistration`	record	A Space published on the relay (`Spaces.relay_register`).
`Spaces`	object	The Spaces registry: add a machine by URL, claim a Fleet Space, provision a local one, and get `Space` handles.
`spaces_tool_methods`	function	Which SDK method covers each Spaces contract tool.
`SpacesdCapabilities`	record	`SystemService.GetCapabilities`, summarized.
`SpacesdClient`	object	Client for one cua-spacesd.
`SpacesdCommand`	record	A command to run in the guest.
`SpacesdFeature`	record	One capability flag.
`SpacesdHttpHeader`	record	One HTTP header (duplicates are kept in order).
`SpacesdHttpRequest`	record	A plain-HTTP request to the spacesd port (for example MCP at `/mcp`).
`SpacesdHttpResponse`	record	The spacesd's HTTP answer.
`SpacesdProcess`	object	A guest process, from `spawn` or `attach`.
`SpaceSendFileOptions`	record	Options for `Space.send_file`.
`SpaceSendFileReport`	record	Result of `Space.send_file`.
`SpaceSentFile`	record	One file placed by `Space.send_file`.
`SpaceShareEntry`	record	One account a Space is shared with.
`SpaceShares`	record	Who a Space is shared with.
`SpacesHost`	record	One of your machines that provides Spaces (`Spaces.hosts`).
`SpacesHostLimit`	record	One limit of a host that provides Spaces and how much of it is used.
`SpacesToolMethod`	record	One row of `SPACES_TOOL_METHODS`.
`SpaceStreamOptions`	record	What to stream and how.
`SpaceStreamSession`	object	A live Space media session (see `Space.stream_session`).
`SpaceStreamStats`	record	Delivery counters of a `SpaceStreamSession`.
`SpaceStreamTicket`	record	A minted media session.
`SpaceToolInfo`	record	A tool of a Space's MCP service.
`SpaceToolResult`	record	The result of a tool call (MCP content as JSON).
`SpaceTransferReport`	record	Result of `Space.upload` / `Space.download`.
`SpaceUsage`	record	Memory and storage use (`Space.usage`).
`SpaceWindow`	record	A streamable window.
`SpaceWriteReport`	record	Result of `Space.write`.
`StorageVolume`	record	Space on the volume a local engine writes to.
`StreamStatsReport`	record	One stream session's aggregate stats (sampled).
`telemetry_acknowledge_notice`	function	Records that the first-run notice was shown in the app's UI (nothing is sent from a machine before that).
`telemetry_flush`	function	Sends queued events now, waiting at most `timeout_ms`; anything left is kept on disk for a later process.
`telemetry_notice_text`	function	The first-run notice text (an app shows it in its own UI, then calls `telemetry_acknowledge_notice`).
`telemetry_record_bench_run`	function	Records a finished cua-bench run: the taskset (catalog name, else `custom`), the aggregate success rate (0 to 1, bucketed), the task count (bucketed) and the outcome (`ok`, `error`, `cancelled`).
`telemetry_record_feature`	function	Records use of a Spaces app feature (fixed names: `space_create_local`, `teleport_drop`, ... see the docs).
`telemetry_record_onboarding_step`	function	Records an install or onboarding funnel step (fixed names: `onboarding_shown`, `signed_in`, `first_space_created`, ...; `first_*` steps count once per install).
`telemetry_record_stream_stats`	function	Records one stream session's aggregate stats (bucketed and sampled).
`telemetry_reset_id`	function	Deletes the anonymous install id and its salt.
`telemetry_schema_json`	function	Every event and property that may be sent, as JSON.
`telemetry_set_enabled`	function	Turns usage telemetry on or off for this machine (`$CUA_HOME/config.toml`, the same switch as `cua telemetry off` and the Spaces app setting).
`telemetry_set_surface`	function	Names the SDK surface events are attributed to.
`telemetry_show_last`	function	The last `limit` events queued or sent from this machine, exactly as sent, as JSON (`[{status, payload}]`).
`telemetry_status`	function	Telemetry state, and exactly what every event carries.
`telemetry_use_app_notice`	function	The host app shows the first-run notice itself (no stderr notice).
`TelemetryStatus`	record	Telemetry state.
`TeleportApprover`	object	The consent gate of `Space.teleport`: shown the manifest, returns the human's decision, or `None` to cancel.
`TeleportDecision`	record	A human's answer to a teleport manifest.
`TeleportItem`	record	One item a teleport would move.
`TeleportManifest`	record	Exactly what would leave this machine.
`TeleportReceipt`	record	What a teleport moved, or how to retry a pending Keyvault approval.
`TransferResult`	record	Result of an upload or download.
`UploadOptions`	record	Upload options.
`VideoFrame`	record	One encoded video access unit.
`ViewerLink`	record	A link to the sandbox desktop in the cua-spacesd HTML5 viewer.
`ViewerOptions`	record	Options for `Sandbox.viewer_url`.

Type notation#

Notation	Python	TypeScript	Swift	Kotlin	Rust
`String`	`str`	`string`	`String`	`String`	`String`
`bool`	`bool`	`boolean`	`Bool`	`Boolean`	`bool`
`u32`	`int`	`number`	`UInt32`	`UInt`	`u32`
`i64`	`int`	`bigint`	`Int64`	`Long`	`i64`
`u64`	`int`	`bigint`	`UInt64`	`ULong`	`u64`
`f64`	`float`	`number`	`Double`	`Double`	`f64`
`Vec<u8>`	`bytes`	`ArrayBuffer`	`Data`	`ByteArray`	`Vec<u8>`
`Vec<T>`	`List[T]`	`Array<T>`	`[T]`	`List<T>`	`Vec<T>`
`Option<T>`	`Optional[T]`	`T \| undefined`	`T?`	`T?`	`Option<T>`
`HashMap<K, V>`	`dict[K, V]`	`Map<K, V>`	`[K: V]`	`Map<K, V>`	`HashMap<K, V>`
`SystemTime`	`datetime.datetime`	`Date`	`Date`	`java.time.Instant`	`SystemTime`
`Duration`	`datetime.timedelta`	`number`	`TimeInterval`	`java.time.Duration`	`Duration`
`Sandbox (an object)`	`Sandbox`	`SandboxLike`	`Sandbox`	`Sandbox`	`Arc<Sandbox>`

Option<T> may be absent: None, undefined, nil, null. A default of None means the argument or field can be left out.

Names in each language#

	Python	TypeScript	Swift	Kotlin	Rust
Import	`import cua`	`import { ... } from '@trycua/cua'`	`import Cua`	`import ai.cua.sdk.*`	`use cua_sdk::*;`
Methods, arguments, fields	`snake_case`	`camelCase`	`camelCase`	`camelCase`	`snake_case`
Enum variants	`UPPER_SNAKE`	`PascalCase`	`lowerCamel`	`UPPER_SNAKE` (plain), `PascalCase` (with fields)	`PascalCase`
Async methods	`async def`, awaited	return a `Promise`, optional `{ signal }`	`async`	`suspend`	`async fn`
Errors	`CuaError.<Variant>`	`CuaError.<Variant>`	`CuaError.<Variant>(message:)`	`CuaException.<Variant>`	`CuaError::<Variant>(String)`
Object handles	the class	the class; arguments and results use the `<Name>Like` interface	the class	the class	`Arc<T>`
Optional arguments	positional (`sb.spacesd(None)`)	`undefined`	`nil`	`null`	`None`

All items#

290 items. Methods are listed on their object.

Item	Kind	Summary
`agent_event_category`	function	The category of an event kind: `message`, `user`, `activity` or `hidden` (the rule `AgentEvent.category` and `AgentTranscript` use).
`agent_harnesses`	function	The harnesses, their readiness, installs, key variables and limits, as JSON.
`AgentActionReport`	record	Result of `Space.agent_message` / `Space.agent_stop`.
`AgentArtifact`	record	A file the run created or changed.
`AgentDelivery`	record	What `Spaces.persistent_agent_send` did.
`AgentEvent`	record	One normalized event.
`AgentEventPage`	record	A page of events.
`AgentFile`	record	A file for the first prompt or a follow-up.
`AgentInfo`	record	One AI coding agent and what cua configured for it.
`AgentMcpServer`	record	The MCP server to register.
`AgentPauseReport`	record	What `Spaces.agent_pause` did.
`AgentResumeReport`	record	What `Spaces.agent_resume` did.
`AgentRun`	object	One run.
`AgentRunInfo`	record	A run's state.
`AgentRunMcpServer`	record	An MCP server a run's agent gets: `url` (streamable HTTP, as reachable from inside the sandbox) or `command` (stdio, run in the sandbox).
`AgentRunOptions`	record	Options for `Agents.run`.
`AgentRunResult`	record	What the last turn produced.
`AgentRunStatus`	record	One agent run's status.
`Agents`	object	Agent runs in one sandbox.
`AgentSetup`	object	Agent onboarding for this machine's user.
`AgentSetupChange`	enum	What happened to one target.
`AgentSetupOutcome`	record	One target's outcome.
`AgentSetupTarget`	enum	What an operation touched.
`AgentStartReport`	record	Result of `Space.agent_start`.
`AgentTranscript`	object	A run's events folded into conversation items, the same rule in every language: the agent's message chunks join into `message` items, the prompt is a `user` item (never repeated as agent text), and consecutive activity of one turn folds into one `activity` group.
`AgentTranscriptItem`	record	One item of an `AgentTranscript`.
`ambiguous_sandbox_candidates`	function	The qualified candidates an `AmbiguousSandbox` message lists (empty for any other message).
`AudioPacket`	record	One audio packet (MEDIA.md §12.2).
`AudioSink`	object	Receives audio packets.
`Auth`	object	Sign-in and the shared session.
`AuthIdentity`	record	Who is signed in (from token claims; display only).
`AuthStatus`	record	The stored session, read without network access.
`BuildFile`	record	A local file copied into a built image.
`BundledSkill`	record	A skill bundled with the SDK.
`canonical_image`	function	The canonical image for `os` (`linux`, `windows`, `macos`) and `version` (`None` = default: `ghcr.io/trycua/linux:24.04`, `ghcr.io/trycua/windows:2022`, `ghcr.io/trycua/macos:26`; macOS accepts `tahoe`/`sequoia`).
`canonical_image_tier`	function	The canonical image for `os`, `version` and `tier`: `slim` (the minimum that passes `cua-spacesd doctor --strict`; CI and benchmarks use it), `full` or `None` (the default, with dev tooling) or, on macOS, `xcode` / `xcode-<X.Y>` (full plus one pinned Xcode).
`check_placement`	function	Checks a location, kind and runtime against each other without creating anything: `InvalidPlacement` (listing the valid values) when the combination does not exist.
`CloudCheck`	record	One check `cloud_test` ran.
`CloudConnected`	record	`cloud_connect`: the connected cloud and the checks it passed.
`CloudCredentials`	record	Where a cloud's credentials were found on this machine (never a secret).
`CloudDisconnected`	record	`cloud_disconnect`.
`CloudKind`	record	What a cloud can run for one image family, and the estimated cost.
`CloudOptions`	record	Advanced options for cloud sandboxes (warm capacity, limits, TTL, a dedicated pool).
`CloudProvider`	record	One cloud as `cloud_status` lists it.
`CloudResource`	record	One thing Cua created in a cloud.
`CloudStatus`	record	`cloud_status`.
`CloudSweepItem`	record	One row of `cloud_sweep`.
`CloudSweepReport`	record	`cloud_sweep`.
`CloudTarget`	record	Where in a cloud account Spaces go.
`CloudTestReport`	record	`cloud_test`.
`ComputerGrant`	record	A persistent agent's grant on one of the user's computers.
`config_get`	function	One setting's effective value and source.
`config_list`	function	Every setting with its effective value and source.
`config_path`	function	The config file's path (`$CUA_HOME/config.toml`).
`config_set`	function	Writes a setting to the config file (checked and normalised: `default.on` takes `local`, `cloud` or a provider).
`config_unset`	function	Removes a setting from the config file.
`ConfigEntry`	record	One setting's effective value.
`Container`	record	An extra container next to a sandbox (a compose-style sidecar), addressed by name on every runtime: the sandbox reaches it at its `name` (on its `ports`), it reaches the sandbox at `main`, and `services` may name its ports (`{"db": 5432}`).
`contrib_providers_built`	function	The contrib providers this build includes (empty unless built with the `contrib` feature).
`Cua`	object	The entry point of the SDK: create one with `Cua::embedded` or `Cua::connect`, then reach sandboxes, Fleet, Spaces and the rest through its accessors.
`cua_sdk_version`	function	Version of the SDK library.
`CuaConfig`	record	Configuration of an embedded SDK runtime.
`CuaError`	error	Every error the SDK raises.
`CuaInfo`	record	Identity of the SDK (and daemon, when connected).
`CuaMode`	enum	Where the SDK runtime lives.
`CursorArt`	record	One cursor shape's shared art: an SVG path on a square canvas, filled with the participant's color over an outline.
`DeviceEnrollment`	record	`Devices.enroll`'s result.
`Devices`	object	This device as a client of the signed-in account on a relay: its enrollment, the account's other devices and its audit log.
`DevicesSnapshot`	record	Everything the Devices page reads, in one call.
`DoctorReport`	record	Doctor output.
`DriveAccessRequest`	record	An agent's request for more access, waiting for the user.
`DriveAudit`	record	The newest audit events and whether the hash chain verified.
`DriveAuditEvent`	record	One audit event.
`DriveCacheStats`	record	The block cache in front of a remote store.
`DriveConflict`	record	A write that lost to a later one, kept in history and as a copy.
`DriveDevice`	record	A device sharing the drive's bucket.
`DriveEntry`	record	One row of a drive listing.
`DriveFile`	record	A file's content and version.
`DriveFileSync`	record	One file's sync state.
`DriveGrant`	record	A widening of an agent's or a Space's access.
`DriveListing`	record	A folder's listing.
`DriveMountStatus`	record	The drive as a volume.
`DriveObject`	record	A written version.
`DrivePendingUpload`	record	A file waiting to upload.
`DriveS3Settings`	record	Where an S3-compatible bucket is (no keys).
`DriveSpaceVolume`	record	The volume mounted in a Space's guest.
`DriveStorage`	record	Where the drive keeps its bytes (Settings > Storage).
`DriveStorageCheck`	record	What a storage test found.
`DriveStorageUpdate`	record	A storage change, or with `dry_run` a connection test.
`DriveSyncEvent`	record	One sync event.
`DriveSyncEvents`	record	Events after a sequence number, and the sequence to ask after next.
`DriveSyncStatus`	record	Sync across devices.
`DriveVersion`	record	One version in a file's history.
`DriveView`	record	Whose view of the drive a call takes: the user (the default, the whole drive) or a persistent agent in a Space.
`error_doc_url`	function	A link to the errors-reference entry of a `CuaError` variant, by name (`InvalidArgument`, case-insensitive).
`ExitInfo`	record	How a process ended.
`FileEntry`	record	A file or directory in the guest.
`Fleet`	object	Fleet control plane.
`fleet_check_runtime`	function	`fleet_resolve_runtime` with the image variant already known (`variant` as `fleet_image_variant` returns it); `None` means the manifest could not be read (an unset runtime then falls back to the reference).
`fleet_generate_claim_token`	function	A fresh per-claim env token (64 hex characters).
`fleet_image_variant`	function	The variant of an image from its registry documents (`manifest`: an image manifest or index, `config`: the platform manifest's config blob): `container-disk`, `rootfs` or `other`.
`fleet_resolve_runtime`	function	The Fleet runtime for `image`: `runtime` (`kubevirt`, `gvisor`) when given, else the one the image needs.
`fleet_size_limits`	function	The everyday sizes of a cloud sandbox (1-8 vCPUs, 1-32 GiB), which the Cua apps offer.
`FleetBillingCard`	record	The saved card (`Fleet.billing_status`): never its number.
`FleetBillingCredit`	record	The account's Cua Cloud credit.
`FleetBillingStatus`	record	The account's Cua Cloud billing (`GET /api/billing/status`).
`FleetClaim`	record	A claim.
`FleetClaimOptions`	record	Claim options for `Fleet.acquire_with`.
`FleetGcReport`	record	What a pool GC did.
`FleetManagedPool`	record	A managed pool (`cua-auto-`, or a legacy `cua-eph-`).
`FleetPool`	record	A pool.
`FleetPoolExport`	record	A pool read back as the shared model, plus its Terraform block.
`FleetPools`	object	Managed pools: what `Sandboxes.create` without a pool uses.
`FleetPoolSpec`	record	A warm pool spec (`Pool.apply` semantics: pool, namespace and template share `name`).
`FleetSandbox`	record	A bound sandbox.
`FleetSettings`	record	Fleet credentials and endpoints.
`FleetSignedUrl`	record	A signed, shareable service URL.
`FleetSizeLimits`	record	The everyday sizes of a cloud sandbox, which the Cua apps offer (`cua_fleet::CLOUD_DEFAULT_RANGE_CPUS`, `cua_fleet::CLOUD_DEFAULT_RANGE_MEMORY_MB`).
`FleetUsagePricing`	record	This account's Cua Cloud rates (`Fleet.usage_pricing`).
`FrameSink`	object	Receives video frames and control events.
`GpuOption`	record	One GPU option of a runtime (see `Spaces.gpu_support`).
`GpuSupport`	record	The GPU options of one runtime: empty, with the reason, when it has none.
`GuestDisplay`	object	The guest display of a sandbox without cua-spacesd (`Sandbox.guest_display`).
`HomeTransfer`	record	What moved between the drive and a Space.
`Host`	object	This machine as an unattended-access host.
`HostAccessRecord`	record	One access to this machine.
`HostPermission`	record	A macOS privacy pane the user must grant.
`HostProvidedSpace`	record	A Space this machine provides to one of your devices.
`HostSettingsChange`	record	A change to this machine's Spaces settings (`None` keeps a value).
`HostSetupOptions`	record	`cua host setup` options.
`HostSpacesAuditRecord`	record	One line of this machine's Spaces audit (remote creates, deletes, refusals and settings changes).
`HostStatus`	record	Host status.
`HttpHeader`	record	An HTTP header.
`HttpResponse`	record	An HTTP response from a sandbox service.
`image_alias`	function	The canonical image a CLI alias (`linux`, `windows`, `macos[:version]`, bare `ubuntu`) names, or `None` for a plain reference (`ubuntu:24.04` is Docker Hub's image).
`ImageBuild`	record	Image layers built on top of a sandbox's image.
`ImageFormat`	enum	Screenshot encoding.
`ImageInfo`	record	The image a sandbox runs, as resolved and pinned at create time.
`ImageLayer`	enum	One image build step (as in `images.cua.ai/v1alpha1` recipes).
`Local`	object	Local runtimes and images.
`LocalImage`	record	A local image.
`LocalStorage`	record	What local Spaces have room for (see `Local.storage`).
`LocationInfo`	record	The locations `on` accepts: `local`, `cloud`, then registered providers.
`locations`	function	Every location with the kinds and runtimes it offers (for pickers and help text).
`LoginAttempt`	object	A started sign-in.
`LoginMethod`	enum	How a sign-in proceeds.
`may_have_fleet_session`	function	Whether a `cua auth login` session may be stored, decided without reading the OS credential vault (the non-secret session marker, or the file store's file).
`mcp_connect`	function	Connects an MCP client to `config` (from `Sandbox.mcp_config`).
`mcp_connect_url`	function	Connects an MCP client to an endpoint URL (`http://host:8765/mcp`; a bare origin means `/mcp`) with `headers` on every request.
`McpClient`	object	An MCP client (rmcp, streamable HTTP; protocol 2026-07-28 when the server supports it, else the server's revision).
`McpConfig`	record	Where an MCP endpoint is and what every request needs.
`MediaBridge`	record	A media bridge for webviews (daemon mode).
`MediaEvent`	record	A control message (`hello`, `session_opened`, `lifecycle`, `audio_config`, `stats`, `error`, ...) or the close of the socket (`kind = "closed"`, `json = {"code":…, "reason":…}`).
`MediaOpenOptions`	record	Media session options.
`MediaSession`	object	A live media session.
`MediaStats`	record	Delivery counters.
`normalize_image`	function	Normalises a reference like the docker CLI (`python` is `docker.io/library/python:latest`).
`NotificationInfo`	record	One entry of the notifications feed.
`omarchy_image`	function	The Omarchy image, `ghcr.io/trycua/omarchy:<channel>` (default `edge`; also `rc`, `stable`): Omarchy (Arch Linux, Hyprland) with cua-spacesd, as an amd64 VM (QEMU locally, KubeVirt in the cloud; emulated on arm64 hosts).
`Overlay`	record	A binary to inject into a sandbox.
`OverlayResult`	record	What an overlay did.
`parse_sandbox_ref`	function	Parses a sandbox ref: `local:<name>`, `cloud:<name>`, `direct:<host:port>`, `relay:<machine-id>`, a legacy spelling (`space://fleet/<ns>/<claim>`, `fleet:<ns>:<claim>`, `url:<addr>`, a URL), or a bare name.
`PersistentAgentInfo`	record	A persistent agent: a named harness whose memory (its home in the Cua Drive) outlives its runs and its Space.
`PersistentAgentOptions`	record	How to create a persistent agent.
`Point`	record	A point.
`PoolOptions`	record	How a pool keeps capacity for a `SandboxSpec`.
`PortForward`	object	An active port forward.
`presence_color`	function	The stable presence color of an agent or other principal (`#rrggbb`): a cursor palette color picked by a hash of `id`.
`presence_conformance_json`	function	The presence conformance vectors (JSON), for binding test suites.
`presence_cursor_art`	function	The shared art for `shape` (unknown names give the arrow).
`presence_cursor_art_all`	function	The shared art for every shape.
`presence_cursor_art_svg`	function	A standalone SVG of `shape` in `color`, `size` pixels square.
`presence_now_ms`	function	The local clock `PresenceView` expects: Unix time in milliseconds.
`presence_text_color`	function	Black or white text (`#000000` / `#ffffff`), whichever reads better on `background` (`#rrggbb`).
`PresenceCursor`	record	A normalized cursor.
`PresenceDrawable`	record	One cursor to draw now (see `PresenceView.drawables`).
`PresenceEvent`	record	A presence event.
`PresenceIdentity`	record	Who joins presence.
`PresenceMember`	record	A roster entry.
`PresenceParticipant`	record	A presence participant.
`PresencePoint`	record	A normalized point.
`PresenceView`	object	The shared presence netcode model: who is present and what to draw, with remote cursors interpolated (render delay, Catmull-Rom, extrapolation cap), idle cursors faded, stale participants dropped and your own cursor at the local pointer (libs/cua/proto/PRESENCE.md section 4).
`ProcessEvent`	record	One output chunk or the exit.
`ProcessEventKind`	enum	Kind of a process event.
`ProcessOutput`	record	Collected output of a finished process.
`PtySize`	record	A PTY size.
`PublicUrl`	record	A shareable URL of a sandbox service that expires.
`qualify_sandbox_ref`	function	Qualifies `name` for a lookup: `local = true` narrows a bare name to `local:<name>`, `false` to `cloud:<name>`, `None` keeps it (a bare name is then searched across locations).
`ReadinessProbe`	record	A user-declared readiness probe.
`RegistrySecret`	enum	Credentials for a private registry image.
`Relay`	object	The signed-in account's view of a cua-relay.
`RelayAuditEvent`	record	One event of the account's audit log.
`RelayClientInfo`	record	Somebody connected to a machine through the relay.
`RelayDevice`	record	A client device of the account, as the relay lists it.
`RelayMachine`	record	A machine of the account's relay directory (`relay:<id>`).
`ReplayMode`	enum	Scrollback replay when attaching.
`resolve_image`	function	Resolves `reference` for `backend` (`auto`, `local`, `fleet`, `container`/`docker`/`gvisor`, `vm`/`qemu`/`kubevirt`, `lume`) on `arch` (`amd64`/`arm64`; `None` = this host, or amd64 for `fleet`).
`resolve_image_with_secret`	function	`resolve_image` for a private image: `secret` joins the head of the registry auth chain (it is read in this process and never cached or logged).
`ResolvedImage`	record	A reference resolved for a backend.
`RoutineInfo`	record	A routine: a recurring turn of a persistent agent, fired by the daemon.
`RuntimeCheck`	record	One doctor check (one backend).
`RuntimeCheckStatus`	enum	Status of one local runtime component.
`Sandbox`	object	A sandbox handle.
`sandbox_locations`	function	Every location word `on=` accepts, in display order: `local`, `cloud`, then the contrib providers (`e2b`, `daytona`, `modal`, ...) and your own clouds (`aws`, `gcp`).
`SandboxCreateOptions`	record	Options for `Sandboxes.create`.
`Sandboxes`	object	Creates, finds and manages sandboxes.
`SandboxInfo`	record	A sandbox as listed.
`SandboxListing`	record	A sandbox listing and what it left out.
`SandboxPhase`	enum	Portable lifecycle phase, the same words local and in the cloud.
`SandboxRefParts`	record	A parsed sandbox ref.
`SandboxSpec`	record	What a sandbox runs: the one model behind `Sandbox.create`, managed pools and `Fleet.apply`.
`SandboxStatus`	enum	Coarse lifecycle status.
`Screenshot`	record	A captured screenshot.
`ScreenshotOptions`	record	Screenshot options.
`Service`	object	A named service of a sandbox.
`ServiceEndpoint`	record	Where a sandbox service is reachable from this process.
`SetupStep`	record	One setup step.
`SiteLoginOptions`	record	Options for `Space.request_site_login`.
`SiteLoginReport`	record	What `Space.request_site_login` did.
`Space`	object	A connected Space.
`SpaceAgentOptions`	record	Options for `Space.agent_start` beyond the harness and prompt.
`SpaceAppIcon`	record	An app icon from `Space.app_icons`: the icon the guest desktop uses, normalized by the SDK's icon cache.
`SpaceAppIconRequest`	record	One window's app, for `Space.app_icons`.
`SpaceBashResult`	record	Output of `Space.bash`.
`SpaceCancelOutcome`	record	What `Spaces.cancel_create` did.
`SpaceCreateListener`	object	Receives `SpaceCreateProgress` while `Spaces.create_with_progress` runs, in order, ending with `ready`.
`SpaceCreateOptions`	record	Options for `Spaces.create`: the same location / kind / runtime model as sandboxes.
`SpaceCreateProgress`	record	What a Space create is doing (see `Spaces.create_with_progress`).
`SpaceCreateResult`	record	Result of `Spaces.create`.
`SpaceDisplay`	record	One of a Space's displays (`Space.displays`).
`SpaceHotspotStatus`	record	Hotspot state.
`SpaceInfo`	record	A registered Space.
`SpacePowerReport`	record	What `Spaces.stop` or `Spaces.start` did.
`SpacePresence`	object	A joined presence session.
`SpaceRelayRegistration`	record	A Space published on the relay (`Spaces.relay_register`).
`Spaces`	object	The Spaces registry: add a machine by URL, claim a Fleet Space, provision a local one, and get `Space` handles.
`spaces_tool_methods`	function	Which SDK method covers each Spaces contract tool.
`SpacesdCapabilities`	record	`SystemService.GetCapabilities`, summarized.
`SpacesdClient`	object	Client for one cua-spacesd.
`SpacesdCommand`	record	A command to run in the guest.
`SpacesdFeature`	record	One capability flag.
`SpacesdHttpHeader`	record	One HTTP header (duplicates are kept in order).
`SpacesdHttpRequest`	record	A plain-HTTP request to the spacesd port (for example MCP at `/mcp`).
`SpacesdHttpResponse`	record	The spacesd's HTTP answer.
`SpacesdProcess`	object	A guest process, from `spawn` or `attach`.
`SpaceSendFileOptions`	record	Options for `Space.send_file`.
`SpaceSendFileReport`	record	Result of `Space.send_file`.
`SpaceSentFile`	record	One file placed by `Space.send_file`.
`SpaceShareEntry`	record	One account a Space is shared with.
`SpaceShares`	record	Who a Space is shared with.
`SpacesHost`	record	One of your machines that provides Spaces (`Spaces.hosts`).
`SpacesHostLimit`	record	One limit of a host that provides Spaces and how much of it is used.
`SpacesToolMethod`	record	One row of `SPACES_TOOL_METHODS`.
`SpaceStreamOptions`	record	What to stream and how.
`SpaceStreamSession`	object	A live Space media session (see `Space.stream_session`).
`SpaceStreamStats`	record	Delivery counters of a `SpaceStreamSession`.
`SpaceStreamTicket`	record	A minted media session.
`SpaceToolInfo`	record	A tool of a Space's MCP service.
`SpaceToolResult`	record	The result of a tool call (MCP content as JSON).
`SpaceTransferReport`	record	Result of `Space.upload` / `Space.download`.
`SpaceUsage`	record	Memory and storage use (`Space.usage`).
`SpaceWindow`	record	A streamable window.
`SpaceWriteReport`	record	Result of `Space.write`.
`StorageVolume`	record	Space on the volume a local engine writes to.
`StreamStatsReport`	record	One stream session's aggregate stats (sampled).
`telemetry_acknowledge_notice`	function	Records that the first-run notice was shown in the app's UI (nothing is sent from a machine before that).
`telemetry_flush`	function	Sends queued events now, waiting at most `timeout_ms`; anything left is kept on disk for a later process.
`telemetry_notice_text`	function	The first-run notice text (an app shows it in its own UI, then calls `telemetry_acknowledge_notice`).
`telemetry_record_bench_run`	function	Records a finished cua-bench run: the taskset (catalog name, else `custom`), the aggregate success rate (0 to 1, bucketed), the task count (bucketed) and the outcome (`ok`, `error`, `cancelled`).
`telemetry_record_feature`	function	Records use of a Spaces app feature (fixed names: `space_create_local`, `teleport_drop`, ... see the docs).
`telemetry_record_onboarding_step`	function	Records an install or onboarding funnel step (fixed names: `onboarding_shown`, `signed_in`, `first_space_created`, ...; `first_*` steps count once per install).
`telemetry_record_stream_stats`	function	Records one stream session's aggregate stats (bucketed and sampled).
`telemetry_reset_id`	function	Deletes the anonymous install id and its salt.
`telemetry_schema_json`	function	Every event and property that may be sent, as JSON.
`telemetry_set_enabled`	function	Turns usage telemetry on or off for this machine (`$CUA_HOME/config.toml`, the same switch as `cua telemetry off` and the Spaces app setting).
`telemetry_set_surface`	function	Names the SDK surface events are attributed to.
`telemetry_show_last`	function	The last `limit` events queued or sent from this machine, exactly as sent, as JSON (`[{status, payload}]`).
`telemetry_status`	function	Telemetry state, and exactly what every event carries.
`telemetry_use_app_notice`	function	The host app shows the first-run notice itself (no stderr notice).
`TelemetryStatus`	record	Telemetry state.
`TeleportApprover`	object	The consent gate of `Space.teleport`: shown the manifest, returns the human's decision, or `None` to cancel.
`TeleportDecision`	record	A human's answer to a teleport manifest.
`TeleportItem`	record	One item a teleport would move.
`TeleportManifest`	record	Exactly what would leave this machine.
`TeleportReceipt`	record	What a teleport moved, or how to retry a pending Keyvault approval.
`TransferResult`	record	Result of an upload or download.
`UploadOptions`	record	Upload options.
`VideoFrame`	record	One encoded video access unit.
`ViewerLink`	record	A link to the sandbox desktop in the cua-spacesd HTML5 viewer.
`ViewerOptions`	record	Options for `Sandbox.viewer_url`.