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#

344 items. Methods are listed on their object.

The 10 items of Batched forks are listed on its page.

The 8 items of Build an image are listed on its page.

The 11 items of Processor, memory and disk are listed on its page.

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…
`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.
`BakeForkCheck`	record	The fork `BakeOptions.verify_fork` made and checked.
`BakeOptions`	record	Options for `Sandboxes.bake`.
`BakeSummary`	record	What `Sandboxes.bake` did and how long each step took (seconds).
`BuildFile`	record	A local file copied into a built image.
`BulkResult`	record	The outcome for one Space of `Spaces.delete_many` or `Spaces.leave_many`.
`BundledSkill`	record	A skill bundled with the SDK.
`canonical_image`	function	The canonical image for `os` (`linux`, `windows`, `macos`) and `version` (`None` = default:…
`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),…
`check_placement`	function	Checks a location, kind and runtime against each other without creating anything: `InvalidPlacement` (listing the valid values) when the combination…
`CheckpointSummary`	record	A named checkpoint of a sandbox, and the machine that holds it.
`CloudAuditEntry`	record	One line of the cloud audit log (`cloud_audit`).
`CloudCheck`	record	One check `cloud_test` ran.
`CloudConnected`	record	`cloud_connect`: the cloud (its `status` is the outcome), the checks it ran, the next step and the command that verifies it.
`CloudConnectOptions`	record	How `cloud_connect` links a cloud, beyond where.
`CloudCostReport`	record	`cloud_cost`: an estimate from list price times runtime.
`CloudCostRow`	record	One row of `cloud_cost`.
`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.
`CloudNext`	record	The next step of a `cloud_connect`: a command for the agent, or a page for a person (and what to paste there), and why.
`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` 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…
`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, 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.
`DefaultSpace`	record	Where the default Space resolves now.
`DefaultSpaceStep`	record	One entry of the order `Devices.resolve_default_space` tried.
`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.
`EgressEnforcement`	enum	Where a Space's egress policy is enforced (`SpaceInfo.egress_enforced`).
`EgressPolicy`	record	Which destinations a Space may open connections to.
`ElasticAssignment`	record	Some Spaces of one group on one machine.
`ElasticBudget`	record	The budget, and what the clouds cost now.
`ElasticBudgetUpdate`	record	The elastic pool's caps and switches (`cloud_budget`): set those given.
`ElasticDecision`	record	One scale-in decision.
`ElasticHost`	record	A host the elastic pool added in one of your clouds.
`ElasticNewHost`	record	A machine the plan adds.
`ElasticPlan`	record	The elastic pool's decision (`cloud_plan`).
`ElasticPlanRequest`	record	What to plan for (`cloud_plan`).
`ElasticRemoved`	record	What `cloud_remove_host` did.
`ElasticUnplaced`	record	Spaces with no place, and why.
`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.
`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.
`HostServiceMigration`	record	What `Host.migrate_service` did.
`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…
`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`, 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.
`MachineHealth`	record	A machine's health as its own cua daemon checks it.
`MachineHealthCheck`	record	One check of a machine's health (`Spaces.machine_health`).
`may_have_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…
`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 =…
`MediaOpenOptions`	record	Media session options.
`MediaSession`	object	A live media session.
`MediaStats`	record	Delivery counters.
`NamedVolume`	record	A named volume of Cua Volume (`Spaces.volumes`).
`NetworkEvent`	record	One kind of connection a Space tried and its network refused (`Spaces.network_log`).
`NetworkSettings`	record	A Space's network settings: a preset and the user's own lists.
`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…
`Overlay`	record	A binary to inject into a sandbox.
`OverlayResult`	record	What an overlay did.
`PairingCode`	record	A one-time code that adds a machine to the account ("Add a machine" by link or QR code).
`parse_sandbox_ref`	function	Parses a sandbox ref: `local:<name>`, `cloud:<name>`, `direct:<host:port>`, `relay:<machine-id>`, a legacy spelling…
`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.
`PoolCreateOptions`	record	What a pool's sandboxes are and how many it keeps ready (`Sandboxes.create_pool`).
`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.
`Prewarm`	record	Spaces of one shape the elastic pool keeps ready: the next creates of that shape claim them in a fraction of a second.
`PrewarmOptions`	record	What to keep ready (`Spaces::prewarm`).
`PrewarmPlacement`	record	Where a prewarm keeps Spaces ready.
`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…
`ReadinessProbe`	record	A user-declared readiness probe.
`RegistrySecret`	enum	Credentials for a private registry image, used for the pull.
`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.
`repo_cache_clear`	function	Deletes every repository the repo cache holds (they are copied again the next time a Space clones them).
`repo_cache_status`	function	The repo cache now: on or off, how much it holds of its cap, and what the last week saved.
`RepoCacheStatus`	record	What the repo cache holds and what it saved, in plain words for Settings (`cache.repos` and `cache.repos_size_gb` are its settings, changed with…
`resolve_image`	function	Resolves `reference` for `backend` (`auto`, `local`, `provider`, `container`/`docker`/`gvisor`, `vm`/`qemu`/`kubevirt`, `lume`) on…
`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.
`RuntimeDetected`	record	A runtime installed on this machine for one kind of Space.
`RuntimeKindState`	record	One kind of Space's runtime, as Settings shows it.
`RuntimePathProbe`	record	What a binary is, for one kind of Space (`runtime_check_path`).
`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…
`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 on every provider.
`SandboxPool`	record	A pool (`Sandboxes.create_pool`).
`SandboxRefParts`	record	A parsed sandbox ref.
`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.
`SetNetworkResult`	record	What `Spaces.set_network` did.
`SetupStep`	record	One setup step.
`Share`	record	One share.
`ShareAccess`	enum	Who may open a share.
`ShareCheck`	record	What opening a link once returned.
`SharedBase`	record	A base image several Spaces share copy-on-write (a container image's layers, the image a VM disk was cloned from).
`ShareLanding`	enum	Where public TCP shares land.
`ShareSettings`	record	The share settings.
`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`.
`SpaceCreatingElsewhere`	record	A Space another of your computers is creating (`SpaceList.creating`).
`SpaceDisplay`	record	One of a Space's displays (`Space.displays`).
`SpaceHotspotStatus`	record	Hotspot state.
`SpaceInfo`	record	A registered Space.
`SpaceList`	record	The Spaces known now (`Spaces.list_known`) and how far the read got.
`SpaceNetworkInfo`	record	A Space's network as `cua network show` says it (`Spaces.network`).
`SpaceOrphan`	record	A child Space whose parent is gone or out of reach (`Spaces.orphans`).
`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`).
`SpaceResizeReport`	record	What `Spaces.resize` did: the shape the Space has now.
`Spaces`	object	The Spaces registry: add a machine by URL, 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.
`SpacesdDownload`	object	A download in progress (`SpacesdClient.open_download`).
`SpacesdFeature`	record	One capability flag.
`SpacesdForward`	object	A loopback (or `bind`) TCP port that reaches a guest port through cua-spacesd's tunnel (`SpacesdClient.forward_tcp`).
`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`.
`SpaceServiceDef`	record	A command a Space keeps running (`Space.put_service`).
`SpaceServiceInfo`	record	A service and how it is doing (`Space.services`).
`SpaceServiceProbe`	record	A health check: exactly one of `http`, `tcp`, `command`.
`SpaceShareEntry`	record	One account a Space is shared with.
`SpaceShares`	record	Who a Space is shared with.
`SpaceSharing`	record	Who a Space belongs to and who else has it, as this account sees it (`SpaceInfo.sharing`).
`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.
`SpacesHostLoad`	record	How busy one of your machines is (its job runner's view).
`SpacesListListener`	object	Hears that the Space list changed (`Spaces.watch_list`).
`SpacesListWatch`	object	A running `Spaces.watch_list`.
`SpacesSettings`	record	The account's default Space and the order to try when it is offline.
`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.
`SpaceTeamShare`	record	A team a Space is shared with (`SpaceSharing.teams`).
`SpaceThumbnail`	record	A Space's latest thumbnail, from the cache every client on this machine shares (`crate.native.spaces.Space.thumbnail`).
`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`.
`SpaceTransport`	record	What carries a connected Space's calls (`Space.transport`), for a badge: whether the relay can read them.
`SpaceUsage`	record	Processor, memory and storage use (`Space.usage`).
`SpaceWindow`	record	A streamable window.
`SpaceWindowOrigin`	record	The Space a window row's picture comes from (`SpaceWindow.origin`).
`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_link_notice`	function	The person closed the linking notice (either button).
`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_link_notice`	function	The one-time linking notice's words.
`telemetry_link_notice_due`	function	Whether the app should show the one-time linking notice now: usage data is on, the account offered linking, and this machine has not shown it.
`telemetry_link_state`	function	Where linking stands: `off`, `not_offered`, `notice_due` or `linked`.
`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)…
`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…
`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_sync_account`	function	Asks the Spaces API for the signed-in account's opaque id and hands it to telemetry (none unlinks).
`telemetry_use_app_notice`	function	The host app shows the first-run notice itself (no stderr notice).
`TelemetryLinkNotice`	record	The one-time notice for machines that saw the older "anonymous" wording, shown before anything is linked to the account.
`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.
`thread_view_of`	function	The `view` of one thread entry or task, given as JSON (an element of `thread_read`'s `entries` or `tasks`, or `thread_inbox`'s `tasks`): none when it…
`ThreadView`	record	What a person was looking at in a Space as they posted to its thread: the Space's desktop, or one of its windows.
`TransferResult`	record	Result of an upload or download.
`TreeBudget`	record	A tree's budget and what its children use (`Spaces.tree_budget`).
`TreeBudgetLimits`	record	What a tree's children may hold and cost (`Spaces.set_tree_budget`).
`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`.
`VolumeMount`	record	A named volume of Cua Volume mounted in a Space: the folder `volumes/<name>/` (or `subpath` inside it) appears at `path`.