Expand description
Provider-neutral workspace contracts and default capability behavior.
Structs§
- AckResponse
- Acquire
Space Write Lease Request - Application
Execution Resource - This handle is usable only by its verified Runtime for the selected Agent.
- Apply
Space Change SetRequest - Bind
Command Context RunRequest - Build
Builtin Snapshot Request - Bytes
Response - Cleanup
Execution Environment Request - Clone
Workspace Request - CmdOutput
- Output of a command execution.
- Command
Context Agent - Authenticated Registry adapter returns only verified bindings, never caller-supplied refs.
- Command
Context Binding - Command
Context Caller - Ephemeral verified user data. SecretValue redacts Debug and is never an API DTO.
- Command
Context Resource - Command
Context RunFence - A worker generation, validated against Execution’s authoritative Run immediately before launch.
- Command
Context Skill - Command
Context Sweep Cursor - Stable keyset cursor for expiry reconciliation; no metadata snapshot scans.
- Command
Permit Request - Command
Resource - Command
Spec - Command
Transition - Complete
Computer Command Request - Computer
Binding - Computer
Command Output Chunk - Computer
Command Output Page - Computer
Command Output Query - Computer
Command Resource - Computer
Command Transition - Computer
Port UrlQuery - Computer
Record - Computer
Resource - Content
Response - Conversation
Space Binding - Create
Application Execution Request - Create
Command Context Request - Create
Command Request - Create
Computer Command Request - Create
Computer Request - Create
Delegation Request - Create
Managed Workload Request - Create
Preview Request - Create
Sandbox Request - Create
Snapshot Request - Create
Snapshot Resource Request - Create
Space Change SetRequest - Create
Space Grant Request - Create
Space Request - Create
Template Version Request - Create
Upload Request - Create
Workspace Policy Request - Create
Workspace Request - Default
Execution Snapshot - Admin-selected public Snapshot. Scope is stored with the ID to avoid changing tenancy.
- Delegation
Record - Delegation
Resource - Delete
Space File Request - DirEntry
- A directory entry returned by
list_dir. - Download
Space File Request - Entries
Response - Environment
Build Observation - Provider build observation captured by background reconciliation. Logs are bounded by the adapter/runtime and never contain provider credentials.
- Environment
Catalog Config - Environment
Domain Error - Environment
Fencing Token Patch - Environment
Idempotency Record - Environment
Metadata Collection Patch - Incremental metadata changes for one aggregate collection.
- Environment
Metadata Patch - Typed delta for one tenant/project Environment aggregate set.
- Environment
Metadata Snapshot - Durable metadata snapshot for one tenant/project scope.
- Environment
Provider Admin Config - Environment
Provider Slot View - Exec
Request - Execution
Environment Cleanup - Execution
Environment Operation - Exists
Response - Export
Space Source Archive Query - File
Visibility Options - Options for directory listing and recursive search operations.
- Find
Files Request - Grep
Match - A grep match result.
- Grep
Request - Grep
Response - Heartbeat
Space Session Request - Install
Computer Skill Request - Install
Computer Skill Resource - Install
Sandbox Skill Request - Install
Sandbox Skill Resource - Install
Space Skill Request - Install
Space Skill Resource - Installed
Space Cli - IsDir
Response - Issue
Space Access Ticket Request - Issued
Execution Environment Operation - Issued
Space Access Ticket - Issued
Space Access Ticket Resource - Keep
Alive Request - List
DirRequest - List
Environment Resources Query - List
Space Files Request - Managed
Workload - Managed
Workload Resource - Migrate
Workspace Request - Moulin
Egress Rule - Exact destination accepted by provider defaults and per-sandbox overrides.
- Open
Space Session Request - Operation
Transition - Output
Chunk - Output
Page - Owner
Ref - Patch
Owners Request - Patch
Resource Alias Request - Mutable human label for an existing Environment resource; identity remains unchanged.
- Path
Request - Paths
Response - PortUrl
- Public preview URL for a port exposed by a workspace backend.
- Port
UrlRequest - Principal
Ref - Project
Command Context Skill - Provider
Build Handle - Provider
Capabilities - Provider
Command Output - Synchronous provider command result. The control plane may persist chunks.
- Provider
Computer Request - Provider-facing request after product identifiers and access tickets have been resolved. These DTOs cannot be supplied by HTTP callers.
- Provider
File Content - Provider
File Entry - Provider
Port Target - Provider-only application-port target resolved inside Agent Infra. Credentials are deliberately non-serializable and redacted from Debug.
- Provider
Request Failure - Provider-neutral failure signal consumed by transport resilience policies.
- Provider
Resource Ref - Provider
Sandbox Mount - Provider
Sandbox Request - Provider
Source Archive - Provider
Space Request - Provider
Write Result - Provision
Execution Environment Request - Provisioned
Workspace - PutWorkspace
File Request - Body for the resource-scoped
PUT .../files/{path}API. The path belongs to the URL so it cannot disagree with a second body field. - Read
File Tail Request - Read
Space File Request - Release
Space Write Lease Request - Remove
File Request - Resolve
Conversation Space Request - Resolve
Execution Target Request - Resolve
Workspace Policy Request - Resolved
Backend Id - Resolved durable backend ID discovered while initializing a workspace. This remains provider-neutral on the wire.
- Resolved
Conversation Space - Resource
Pressure - Resource
Scope - Resource
Usage Value - Revoke
Space Grant Request - Sandbox
Mount - Sandbox
Mount Record - Persisted mount metadata. The bearer token from
SandboxMountis deliberately replaced by its non-secret ticket id before persistence. - Sandbox
Record - Sandbox
Resource - Sandbox
Resources - System resources assigned to one provider Computer/Sandbox. Units match the provider control planes and keep invalid budgets out of Runtime.
- Secret
Ref - Opaque reference resolved only by a trusted adapter. The secret value is
deliberately impossible to serialize or expose through
Debug. - Skill
CliPackage - Skill
Package - Skill
Package File - Skill
Search Item - Skill
Search Page - Skill
Search Query - Snapshot
- Snapshot
Object Ref - Snapshot
Record - Snapshot
Resource - Space
Access Ticket Record - Space
Access Ticket Resource - Space
Change SetRecord - Space
Change SetResource - Space
Collaboration Session - Space
Collaboration Session Resource - Space
File Content - Space
File Entry - Space
Grant - Space
Grant Resource - Space
Record - Space
Resource - Space
Skill Installation - Space
Write Lease - Space
Write Lease Resource - Static
Preview Server - Store
Computer Command Request - Durable, scope-qualified command creation input owned by the Workspace command repository. Only hashes of caller idempotency material cross the persistence boundary.
- Stored
Change Set - Stored
Command Context - Internal persistence model. Never serialize this record into an API response.
- Stored
Preview - Stored
Snapshot - Template
Version Record - Template
Version Resource - Temporary
Command Context Skill - Uninstall
Space Skill Request - Uninstall
Space Skill Resource - Update
Environment Provider Admin Config Request - Update
Environment Provider Slot Request - Update
Workspace Policy Request - Upload
Chunk Request - Upload
Session - User
Computer Binding - First-creation input is immutable even when Admin defaults change during retry.
- Verified
Application Execution - Internal authenticated context, never accepted from a JSON body or JWT claim.
- Versioned
File - Walk
Tree Request - Workspace
Action Request - Workspace
ApiError - Workspace
Capabilities - Workspace
Change Set - Workspace
Change SetRequest - Workspace
Change Summary - Workspace
Config - Provider-neutral provisioning input. Provider-specific SDK/configuration belongs to an adapter crate; the contract contains only a backend kind, opaque settings and secret references.
- Workspace
Error Details - Workspace
File Change - Workspace
Lease - Workspace
Lease Keep Alive - Workspace
Moulin Build Admin Config - Non-secret defaults materialized into direct Workspace Moulin BuildJobs.
- Workspace
Operation - Workspace
Operation Error - Workspace
Page - Workspace
Policy Binding - Workspace
Policy Definition - Workspace
Policy Record - Workspace
Record - Workspace
Resource Usage - Workspace
Search Request - One bounded typed search entry point. Fields that do not apply to the selected kind are rejected by the service rather than guessed.
- Workspace
Search Response - Workspace
Session - Workspace
Storage Usage - Workspace
Text Replacement - Workspace
Version Conflict - Write
File Bytes Request - Write
File Request - Write
Space File Request
Enums§
- Change
SetLifecycle - Command
Context Skill Source - Command
Context State - Command
Network Policy - Command
State - Computer
Command Output Stream - Computer
Command State - Computer
Lifecycle - E2bImage
Build Recipe - Environment
Build Status - Environment
Error Code - Environment
Idempotency State - Environment
Image Build Request - Type-driven provider dispatch. Invalid combinations such as a Moulin template build cannot cross the application-to-adapter port.
- Environment
Resource Kind - Existence checks reveal no foreign aggregate or owner metadata.
- Execution
Environment Source - Managed
Workload Isolation - Managed
Workload State - Moulin
Build Network Policy - Provider-enforced Build connectivity sent through Agent Deploy to Moulin.
- Moulin
Image Build Recipe - Operation
State - Output
Stream - Owner
Kind - Resource owner identity. At least one owner is required on every Environment resource; callers authenticate with runtime, agent, or user credentials.
- Owner
Validation Error - Principal
Kind - Provider
Port Authorization - Provider-only authentication for an application-port target.
- Provider
Sandbox Placement - Provider
Snapshot Source - Resource
Pressure Dimension - Resource
Pressure Severity - Resource
Usage Status - Sandbox
Lifecycle - Sandbox
Placement - Snapshot
Build Spec - Snapshot
Lifecycle - Snapshot
Source Record - Snapshot
Visibility - Space
Access Mode - Space
Capability - Space
Lifecycle - Space
Persistence - Space
Session Lifecycle - Space
Skill Installation State - Installation metadata contains no environment values or credentials.
- Store
Computer Command Outcome - Template
Target - Template
Version State - Upload
State - Workspace
Archive Format - Directory archive format; regular files always retain their original bytes.
- Workspace
Binding State - Workspace
Build Provider - Provider identity at the Workspace image-build boundary. Product records may remain wire-compatible strings, while build adapters cannot receive an unknown provider.
- Workspace
Change SetStatus - Workspace
File Change Kind - Workspace
Lifecycle - Workspace
Patch Operation - Workspace
Policy Scope - Workspace
Policy Source - Workspace
Search Kind
Constants§
- ADMIN_
BUILD_ BUILTIN_ SNAPSHOTS_ PATH - ADMIN_
COMPUTERS_ PATH - Privileged inventory and terminal routes used only by the Infra Admin console. They are intentionally separate from the owner-scoped public Environment API.
- ADMIN_
COMPUTER_ COMMANDS_ PATH - ADMIN_
COMPUTER_ COMMAND_ CANCEL_ PATH - ADMIN_
COMPUTER_ COMMAND_ OUTPUT_ PATH - ADMIN_
COMPUTER_ COMMAND_ PATH - ADMIN_
SNAPSHOTS_ PATH - ADMIN_
SNAPSHOT_ PATH - ADMIN_
SPACES_ PATH - ADMIN_
WORKSPACE_ MOULIN_ BUILD_ CONFIG_ PATH - APPLICATION_
AGENT_ HEADER - APPLICATION_
CALLER_ HEADER - APPLICATION_
COMMAND_ CONTEXTS_ PATH - APPLICATION_
EXECUTIONS_ PATH - APPLICATION_
EXECUTION_ HEADER - APPLICATION_
EXECUTION_ MAX_ TTL_ MS - BUILD_
BUILTIN_ SNAPSHOTS_ PATH - CATALOG_
SNAPSHOTS_ PATH - CATALOG_
SNAPSHOT_ PATH - COMMAND_
CONTEXTS_ PATH - COMMAND_
CONTEXT_ BIND_ RUN_ PATH - COMMAND_
CONTEXT_ CLOSE_ PATH - COMMAND_
CONTEXT_ MAX_ TTL_ MS - COMMAND_
CONTEXT_ PATH - COMPUTERS_
PATH - COMPUTER_
COMMANDS_ PATH - COMPUTER_
COMMAND_ CANCEL_ PATH - COMPUTER_
COMMAND_ OUTPUT_ PATH - COMPUTER_
COMMAND_ PATH - COMPUTER_
OWNERS_ PATH - COMPUTER_
PATH - COMPUTER_
PORT_ PROXY_ PATH - COMPUTER_
PORT_ PROXY_ ROOT_ PATH - COMPUTER_
PORT_ PROXY_ ROOT_ SLASH_ PATH - COMPUTER_
PORT_ URL_ PATH - COMPUTER_
SKILLS_ PATH - Install code only at a Computer-owned, Agent/version-isolated location.
- COMPUTER_
SNAPSHOTS_ PATH - CONVERSATION_
SPACE_ RESOLVE_ PATH - DELEGATIONS_
PATH - DELEGATION_
REVOKE_ PATH - E2B_
BUILTIN_ TEMPLATE_ IDS - E2B_
PLATFORM_ TEMPLATE_ ID - Provider-owned images used when product create APIs omit every Workspace catalog snapshot/template selector. Scope-owned snapshots are selected only by an explicit snapshot id.
- ENVIRONMENT_
MAX_ FILE_ BYTES - ENVIRONMENT_
MAX_ PATH_ BYTES - EXECUTION_
OPERATIONS_ PATH - EXECUTION_
OPERATION_ CLEANUP_ PATH - EXECUTION_
TARGET_ RESOLVE_ PATH - MANAGED_
WORKLOADS_ PATH - MANAGED_
WORKLOAD_ PATH - MANAGED_
WORKLOAD_ STOP_ PATH - MOULIN_
PLATFORM_ SNAPSHOT_ ID - SANDBOXES_
PATH - SANDBOX_
PATH - SANDBOX_
SKILLS_ PATH - Product path for installing a Skills Hub package into a running Sandbox.
- SANDBOX_
SKILL_ DEFAULT_ PROVIDER - Default sandbox provider when the caller omits
provider. - SANDBOX_
SKILL_ DEFAULT_ VERSION - Default Skills Hub version selector when the caller omits
version. - SANDBOX_
SKILL_ INSTALL_ ROOT - Sandbox-root directory that receives unpacked skill packages.
- SANDBOX_
STOP_ PATH - SKILLS_
SEARCH_ PATH - Product path for searching published Skills Hub packages.
- SKILL_
CLI_ MAX_ BYTES - One shared budget bounds both a downloaded CLI and all CLI dependencies of a Skill. Standalone runtimes (for example Ignis) can exceed 64 MiB.
- SKILL_
ENV_ FILE - POSIX export file written next to installed skill packages so later execs
can inject
os.environvalues. - SKILL_
ENV_ MAX_ ENTRIES - Maximum number of environment variables accepted on one skill install.
- SKILL_
ENV_ MAX_ VALUE_ BYTES - Maximum UTF-8 bytes allowed for one skill environment value.
- SNAPSHOTS_
PATH - SNAPSHOT_
ARTIFACT_ PATH - SNAPSHOT_
DOCKERFILE_ MAX_ BYTES - Product-facing snapshot recipe size limits. The build adapters impose additional limits on fetched repository contents and generated archives.
- SNAPSHOT_
PATH - SNAPSHOT_
TEMPLATE_ PACKAGES_ MAX_ BYTES - SPACES_
PATH - SPACE_
CHANGE_ SETS_ PATH - SPACE_
CHANGE_ SET_ APPLY_ PATH - SPACE_
CLI_ INSTALL_ ROOT - SPACE_
FILES_ DOWNLOAD_ PATH - SPACE_
FILES_ LIST_ PATH - SPACE_
FILES_ PATH - SPACE_
FILES_ READ_ PATH - SPACE_
GRANTS_ PATH - SPACE_
GRANT_ REVOKE_ PATH - SPACE_
LEASES_ PATH - SPACE_
LEASE_ PATH - SPACE_
OWNERS_ PATH - SPACE_
PATH - SPACE_
SESSIONS_ PATH - SPACE_
SESSION_ CLOSE_ PATH - SPACE_
SESSION_ HEARTBEAT_ PATH - SPACE_
SKILLS_ PATH - Product path for installing a Skills Hub package into a Runtime-bound Space.
- SPACE_
SKILL_ INSTALL_ ROOT - Space-relative directory that Runtime workspace tools expose to the agent.
- SPACE_
SKILL_ UNINSTALL_ PATH - SPACE_
SOURCE_ ARCHIVE_ PATH - SPACE_
TICKETS_ PATH - TEMPLATES_
PATH - TEMPLATE_
VERSIONS_ PATH - TEMPLATE_
VERSION_ DEPRECATE_ PATH - TEMPLATE_
VERSION_ PATH - TEMPLATE_
VERSION_ PUBLISH_ PATH - WORKSPACES_
PATH - WORKSPACE_
CLONE_ PATH - WORKSPACE_
COMMANDS_ PATH - WORKSPACE_
COMMAND_ CANCEL_ PATH - WORKSPACE_
COMMAND_ OUTPUT_ PATH - WORKSPACE_
COMMAND_ PATH - WORKSPACE_
LEASE_ PATH - WORKSPACE_
MAX_ COMMAND_ BYTES - WORKSPACE_
MAX_ COMMAND_ CPU_ MILLIS - WORKSPACE_
MAX_ COMMAND_ DISK_ BYTES - WORKSPACE_
MAX_ COMMAND_ MEMORY_ BYTES - WORKSPACE_
MAX_ COMMAND_ OUTPUT_ BYTES - WORKSPACE_
MAX_ COMMAND_ PROCESSES - WORKSPACE_
MAX_ COMMAND_ TIMEOUT_ MS - WORKSPACE_
MAX_ FILE_ BYTES - WORKSPACE_
MAX_ MANAGED_ WORKLOAD_ TIMEOUT_ MS - WORKSPACE_
MAX_ OUTPUT_ CHUNKS - WORKSPACE_
MAX_ PAGE_ SIZE - WORKSPACE_
MAX_ PATH_ BYTES - WORKSPACE_
MAX_ RESULTS - WORKSPACE_
MAX_ RETENTION_ MS - WORKSPACE_
MAX_ SEARCH_ OUTPUT_ BYTES - WORKSPACE_
MAX_ SNAPSHOT_ BYTES - WORKSPACE_
MAX_ UPLOAD_ BYTES - WORKSPACE_
MIGRATE_ PATH - WORKSPACE_
MISSING_ FILE_ REVISION - Reserved compare-and-swap revision representing an absent file.
- WORKSPACE_
MOULIN_ BUILD_ CONFIG_ PATH - WORKSPACE_
OPERATIONS_ PATH - WORKSPACE_
OPERATION_ CANCEL_ PATH - WORKSPACE_
OUTPUT_ CHUNK_ BYTES - WORKSPACE_
PATH - WORKSPACE_
POLICIES_ PATH - WORKSPACE_
POLICY_ BINDING_ PATH - WORKSPACE_
POLICY_ BINDING_ RELEASE_ PATH - WORKSPACE_
POLICY_ PATH - WORKSPACE_
POLICY_ RESOLVE_ PATH - WORKSPACE_
PREVIEW_ TTL_ MS - WORKSPACE_
RECONCILE_ PATH - WORKSPACE_
RESOURCE_ EXHAUSTED_ CODE - WORKSPACE_
RESOURCE_ FILE_ PATH - Resource-scoped file API used by leftover managed callers.
filePathis an axum catch-all and therefore may contain workspace-relative/separators. - WORKSPACE_
RESOURCE_ SEARCH_ PATH - WORKSPACE_
RESUME_ PATH - WORKSPACE_
SERVICE_ NAME - WORKSPACE_
SNAPSHOTS_ PATH - WORKSPACE_
SNAPSHOT_ ARCHIVE_ MAGIC - WORKSPACE_
SNAPSHOT_ RESTORE_ PATH - WORKSPACE_
SUSPEND_ PATH - WORKSPACE_
UPLOADS_ PATH - WORKSPACE_
UPLOAD_ CHUNK_ BYTES - Resumable uploads deliberately use small chunks so request memory is bounded independently from the maximum completed file size.
- WORKSPACE_
UPLOAD_ PATH - WORKSPACE_
UPLOAD_ TTL_ MS - WORKSPACE_
USAGE_ PATH - WORKSPACE_
VERSION_ CONFLICT_ CODE
Traits§
- Command
Context Agent Source - Command
Context Repository - Dedicated indexed storage; contexts never inflate the scope metadata snapshot.
- Command
Context RunSource - Command
Permit Repository - Computer
Provider - Environment
Build Port - Build-only port. Implementations must not create Computer or Sandbox instances.
- Environment
Command Repository - Command metadata and output are stored independently from the Environment aggregate snapshot. This keeps output appends O(chunks) instead of copying every resource in a tenant/project scope.
- Environment
Metadata Repository - Environment
Provider Registry - Environment
Repository - Production Environment persistence owns both aggregate metadata and the independently indexed command log.
- Preview
Lifecycle Provider - Provider
Resilience Policy - Narrow strategy port for provider retry and circuit-opening decisions.
- Sandbox
Provider - Secret
Resolver - Skill
HubClient - Downloads a published skill archive. Implementations live in adapter crates.
- Snapshot
Object Reader - Bounded, random-access reader used across application and object-store
ports. Implementations must never return more than
max_bytes. - Snapshot
Object Store - Snapshot
Object Upload - Snapshot
Provider - Snapshot
Provider Port - Space
Provider - Template
Provider Port - Workspace
- The core workspace trait. All filesystem and command execution flows through this.
- Workspace
Advanced Repository - Workspace
Command Executor - Workspace
Commands - Narrow command capability. Possession of this port is an explicit privilege.
- Workspace
Control Repository - Workspace
Files - Narrow file capability for consumers that must not gain command execution.
- Workspace
Provider Adapter - Workspace
Provider Registry - Workspace
Repository - Aggregate metadata port used by the application layer. Concrete SQL/storage technology belongs in adapter crates.
- Workspace
Search - Narrow bounded-search capability.
- Workspace
Session Resolver - Workspace
Upload Writer
Functions§
- command_
env_ export_ prefix export NAME='value';prefix so a later command can override a sourced skill.envfile. Invalid names are skipped; callers should validate first.- content_
revision - Collision-resistant content revision shared by CAS and idempotency paths.
- default_
workspace_ provider - Default runtime provider for newly created remote Workspace resources.
- encode_
skill_ env_ file export NAME='value'file that login/non-login shells can source.- is_
command_ context_ lifecycle_ path - Context lifecycle URLs contain no Computer id. The edge checks execution capability; Workspace then checks the stored owner/executor and Space grant. Creation remains a caller-authorized operation, never a Runtime lifecycle call.
- is_
workspace_ resource_ exhausted_ message - normalize_
owners - Normalize owners: non-empty, deduplicated, stable order.
- normalize_
workspace_ operation_ error - owners_
intersect - True when caller and resource owners share at least one identity.
- owners_
subset_ of - True when
candidateis a subset ofparent(every element of candidate in parent). - parse_
skill_ env_ file - Parse the file produced by
encode_skill_env_file. - posix_
single_ quote - required_
workspace_ capability - Return the capability required by both the public Gateway alias and the internal Workspace service route. Keeping this decision in the contract prevents the Gateway-issued downstream credential from drifting away from the capability independently enforced by the Workspace server.
- revision_
matches - sandbox_
skill_ env_ abs_ path - Absolute path providers source before executing a command in a Sandbox.
- skill_
env_ source_ prefix - Prefix that no-ops when the skill env file is absent.
- snapshot_
digest - space_
directory_ path - Logical directory for a Space on its parent Computer filesystem.
- space_
skill_ env_ abs_ path - Absolute path providers source before executing a command in a Space.
- strip_
environment_ api_ prefix - Strip
/internal/v1or/v1, then the Environment domain prefix/workspacewhen it is a full path segment./workspaces(plural managed API) is left intact. - valid_
computer_ command_ transition - valid_
skill_ env_ name - POSIX identifier:
[A-Za-z_][A-Za-z0-9_]*. - validate_
moulin_ egress_ rules - Validate the bounded request-level or provider-level Moulin policy.
- validate_
skill_ env - Validate skill-install environment names and values.
- workspace_
error_ details