api

Nov 5, 2026

Changes in this version

+ type ComputerPayload struct

+ Action string

+ Input json.RawMessage

+ Text string

type DecideInterventionRequest

+ EditedText *string

+ type HitlDecider struct

+ Secret string

+ URL string

type HitlGate

+ Decide *HitlDecider

type HitlGateMatch

+ TextContains []string

type HitlRequests

+ Review *HitlReviewRequests

+ type HitlReviewRequests struct

+ type InterventionDecider struct

+ Error string

+ Reason string

+ Verdict string

type InterventionDecision

+ EditedText *string

type InterventionPayload

+ Computer *ComputerPayload

+ Decider *InterventionDecider

+ Review *InterventionReview

type InterventionResult

+ Computer *ComputerActionResponse

+ type InterventionReview struct

+ Content string

+ Format string

+ Message string

+ Path string

+ Truncated bool

type RequestHumanRequest

+ Content string

+ Format string

+ Path string

Nov 5, 2026

Changes in this version

+ const CodeForbidden

+ const CodeLocked

type APIKey

+ Actor *ActorLabel

+ CreatedBy string

+ EnvID string

+ ExpiresAt *time.Time

+ Scopes []string

+ type Actor struct

+ ID string

+ KeyID string

+ Name string

+ Source string

+ type ActorLabel struct

+ ID string

+ Name string

+ type AnswerSecretRequest struct

+ Value string

+ type AuditEntry struct

+ Actor Actor

+ At time.Time

+ EnvID string

+ Event string

+ Hash string

+ InterventionID string

+ PrevHash string

+ RecordingID string

+ RemoteAddr string

+ Seq int64

+ type AuditList struct

+ Entries []AuditEntry

+ NextCursor *string

type CreateAPIKeyRequest

+ Actor *ActorLabel

+ EnvID string

+ Scopes []string

+ TTLSeconds int64

type CreateEnvironmentRequest

+ Hitl *HitlSpec

+ type DecideInterventionRequest struct

+ Answer string

+ EditedArgv []string

+ ExtendSeconds int64

+ Grant string

+ Reason string

+ type ExecPayload struct

+ Argv []string

+ Shell string

+ TimeoutMS int64

+ type HeldResponse struct

+ Intervention Intervention

+ InterventionID string

+ type HitlAskRequests struct

+ type HitlExecPolicy struct

+ Allow []string

+ Default string

+ type HitlGate struct

+ Grant string

+ Match HitlGateMatch

+ Mode string

+ Name string

+ On string

+ Reason string

+ TimeoutSeconds int64

+ type HitlGateMatch struct

+ Action []string

+ Args []string

+ BeforeSeconds int64

+ Failures int

+ Program []string

+ QuietSeconds int64

+ Shell bool

+ type HitlRequests struct

+ Ask *HitlAskRequests

+ Secret *HitlSecretRequests

+ Takeover *HitlTakeoverRequests

+ type HitlSecretRequests struct

+ Targets []HitlSecretTarget

+ type HitlSecretTarget struct

+ Env string

+ File string

+ Label string

+ type HitlSpec struct

+ Exec *HitlExecPolicy

+ Gates []HitlGate

+ Notify []HitlWebhook

+ OnTimeout string

+ Requests HitlRequests

+ RequireActor bool

+ TimeoutSeconds int64

+ type HitlTakeoverRequests struct

+ Via []string

+ type HitlWebhook struct

+ Secret string

+ URL string

+ type Intervention struct

+ CreatedAt time.Time

+ Deadline time.Time

+ Decision *InterventionDecision

+ EnvID string

+ Gate string

+ ID string

+ Kind string

+ Mode string

+ OnTimeout string

+ Payload InterventionPayload

+ Result *InterventionResult

+ State string

+ TriggeredBy Actor

+ UpdatedAt time.Time

+ type InterventionDecision struct

+ Answer string

+ DecidedAt time.Time

+ DecidedBy Actor

+ EditedArgv []string

+ Grant string

+ Outcome string

+ Reason string

+ type InterventionList struct

+ Interventions []Intervention

+ NextCursor *string

+ type InterventionPayload struct

+ Choices []string

+ Exec *ExecPayload

+ Lifecycle *LifecyclePayload

+ Question string

+ Secret *InterventionSecret

+ Signal *InterventionSignal

+ Takeover *InterventionTakeover

+ type InterventionResult struct

+ EnvID string

+ Error string

+ Exec *ExecEnvironmentResponse

+ FinishedAt time.Time

+ SnapshotID string

+ type InterventionSecret struct

+ Label string

+ Message string

+ Target string

+ type InterventionSignal struct

+ ExtendedUntil *time.Time

+ Failures int

+ LastExitCode int

+ QuietSeconds int64

+ ReapAt *time.Time

+ Reaper string

+ type InterventionTakeover struct

+ Holder *Actor

+ Reason string

+ StartedAt *time.Time

+ Via string

+ type LifecyclePayload struct

+ Action string

type Principal

+ Actor hitl.Actor

+ EnvID string

+ ExpiresAt *time.Time

+ FirstUse bool

+ Label string

+ PinnedActor *hitl.Actor

+ Scopes []hitl.Scope

+ type ReleaseRequest struct

+ Note string

+ type RequestHumanRequest struct

+ Choices []string

+ Kind string

+ Message string

+ Question string

+ Reason string

+ Target string

+ TimeoutSeconds int64

+ Via string

+ type TakeoverRequest struct

+ Reason string

+ Via string

Oct 2, 2026

Changes in this version

type ComputerDisplay

+ WM string

type DesktopSpec

+ WM string

Oct 2, 2026

Changes in this version

type MigrateEnvironmentRequest

+ Lazy bool

+ Live bool

type ResourceSpec

+ HugePages bool

Sep 20, 2026

Changes in this version

+ type MigrateEnvironmentRequest struct

+ TargetHostID string

Sep 18, 2026

Changes in this version

type CreateEnvironmentRequest

+ Egress *EgressSpec

+ type EgressHealth struct

+ CheckedAt time.Time

+ Reason string

+ State string

+ type EgressSpec struct

+ Mode string

+ Protocol string

+ Provider string

+ type EgressStatus struct

+ Endpoint string

+ Health *EgressHealth

+ Mode string

+ Protocol string

+ Provider string

type Environment

+ Egress *EgressStatus

Sep 12, 2026

Changes in this version

type Endpoint

+ Protocol string

type ExposeSpec

+ Protocol string

Aug 23, 2026

Changes in this version

type CreateSnapshotRequest

+ Live bool

type Snapshot

+ Kind string

Aug 15, 2026

Changes in this version

+ type ComputerActionRequest struct

+ Action string

+ Coordinate []int

+ Duration float64

+ Region []int

+ ScrollAmount int

+ ScrollDirection string

+ StartCoordinate []int

+ Text string

+ type ComputerActionResponse struct

+ Output string

+ Screenshot string

+ type ComputerDisplay struct

+ Display string

+ Error string

+ Height int

+ Up bool

+ Width int

type CreateEnvironmentRequest

+ Desktop *DesktopSpec

+ type DesktopSpec struct

+ Height int

+ Width int

Aug 15, 2026

Changes in this version

type CreateEnvironmentRequest

+ Files map[string]string

+ Healthcheck *HealthcheckSpec

type Environment

+ Health *Health

+ type Health struct

+ Failures int

+ Message string

+ Since time.Time

+ State string

+ type HealthcheckHTTP struct

+ Path string

+ Port int

+ type HealthcheckSpec struct

+ Exec []string

+ HTTP *HealthcheckHTTP

+ IntervalSeconds int64

+ Retries int

+ StartPeriodSeconds int64

+ TimeoutSeconds int64

Aug 14, 2026

Changes in this version

type CreateSnapshotRequest

+ LayerKey string

+ type ResolveSnapshotResponse struct

+ Found bool

+ Snapshot *Snapshot

type Snapshot

+ Arch string

+ Digest string

+ LayerKey string

Aug 10, 2026

Changes in this version

type EnvironmentList

+ NextCursor *string

type HostList

+ NextCursor *string

type SnapshotList

+ NextCursor *string

Aug 2, 2026

Changes in this version

type HostCapacity

+ Arch string

type ResourceSpec

+ Arch string

Jul 31, 2026

Changes in this version

type CreateEnvironmentRequest

+ StartupScriptTimeoutSeconds int64

Jul 30, 2026

Changes in this version

type HostInfo

+ Labels map[string]string

type RegisterHostRequest

+ Labels map[string]string

type ResourceSpec

+ HostID string

+ IdleTimeoutSeconds int64

+ Labels map[string]string

Jul 30, 2026

Changes in this version

type CreateEnvironmentRequest

+ SeedSnapshotID string

type Snapshot

+ Name string

Jul 29, 2026

Changes in this version

+ const CodePayloadTooLarge

+ const MaxEnvironmentBodyBytes

+ const MaxJSONBodyBytes

+ const MaxLoginBodyBytes

Jul 20, 2026

Changes in this version

type HostCapacity

+ MIGInstanceUUIDs []string

+ MIGInstances []MIGInstance

+ type MIGInstance struct

+ Kind string

+ ParentGPUUUID string

+ Profile string

+ UUID string

Jul 19, 2026

Changes in this version

+ type GPUDevice struct

+ CUDAVersion string

+ ComputeCap string

+ DriverVersion string

+ IOMMUGroup string

+ MIGCapable bool

+ MIGMode string

+ MemoryMB int

+ Model string

+ PCIBusID string

+ UUID string

type HostCapacity

+ GPUDevices []GPUDevice

+ MIGProfiles map[string]int

type ResourceSpec

+ GPUProfile string

Jul 17, 2026

Changes in this version

+ const CodeRouteNotFound

type Handler

+ Version string

type Healthcheck

+ BuildVersion string

+ func (h *Healthcheck) Version(w http.ResponseWriter, _ *http.Request)

Jul 15, 2026

Changes in this version

+ const CodeUnimplemented

+ type ExecEnvironmentRequest struct

+ Cmd []string

+ Shell string

+ TimeoutMS int

+ type ExecEnvironmentResponse struct

+ ExitCode int

+ Stderr string

+ Stdout string

type HostInfo

+ Warnings []string

Jul 12, 2026

Changes in this version

type HostCapacity

+ GPUKind string

+ GPUs int

type HostInfo

+ Backend string

type RegisterHostRequest

+ Backend string

type ResourceSpec

+ GPUKind string

+ GPUs int32

Jul 4, 2026

Changes in this version

type CreateEnvironmentRequest

+ Expose []ExposeSpec

+ type Endpoint struct

+ As string

+ Port int

+ URL string

type Environment

+ Endpoints []Endpoint

+ type ExposeSpec struct

+ As string

+ Port int

+ type ForkEnvironmentRequest struct

+ Comment string

+ ReuseSnapshotID string

type ResourceSpec

+ Image string

Jun 30, 2026

Changes in this version

+ const CodeConflict

+ const CodeInternal

+ const CodeInvalidArgument

+ const CodeNotFound

+ const CodeUnauthorized

+ const CodeUnavailable

+ const RequestIDHeader

+ const SessionCookieName

+ func BearerAuth(expectedToken string, keys APIKeyAuthenticator, onFailure AuthFailureFunc) func(http.Handler) http.Handler

+ func CIDRAllowlist(cidrs []string, onReject IPRejectFunc) (func(http.Handler) http.Handler, error)

+ func MetricsMiddleware(requestsTotal *prometheus.CounterVec, requestDuration *prometheus.HistogramVec, ...) func(http.Handler) http.Handler

+ func RequestID(ctx context.Context) string

+ func RequestIDMiddleware(next http.Handler) http.Handler

+ type APIKey struct

+ CreatedAt time.Time

+ ID string

+ Label string

+ LastUsedAt *time.Time

+ RevokedAt *time.Time

+ type APIKeyAuthenticator interface

+ Authenticate func(ctx context.Context, rawToken string) (string, bool)

+ type APIKeyList struct

+ APIKeys []APIKey

+ type APIKeyStore interface

+ Authenticate func(ctx context.Context, rawToken string) (string, bool)

+ Create func(ctx context.Context, label string, now time.Time) (apikeys.APIKeyRecord, string, error)

+ List func(ctx context.Context) ([]apikeys.APIKeyRecord, error)

+ Revoke func(ctx context.Context, id string, now time.Time) error

+ type AuthFailureFunc func(remoteAddr, method, path, requestID string)

+ type CreateAPIKeyRequest struct

+ Label string

+ type CreateAPIKeyResponse struct

+ Key string

+ type CreateEnvironmentRequest struct

+ GatewayToken string

+ GatewayURL string

+ ManifestInline string

+ Secrets map[string]string

+ Spec ResourceSpec

+ StartupScript string

+ TaskID string

+ type CreateSnapshotRequest struct

+ Comment string

+ ExportRef string

+ ExportStatus string

+ Metadata map[string]string

+ Mode string

+ RetentionSeconds int64

+ type Environment struct

+ CreatedAt time.Time

+ Error string

+ HostID string

+ ID string

+ Spec ResourceSpec

+ State string

+ TaskID string

+ URL string

+ UpdatedAt time.Time

+ type EnvironmentList struct

+ Environments []Environment

+ type Error struct

+ Error ErrorBody

+ type ErrorBody struct

+ Code string

+ Details map[string]string

+ Message string

+ type Handler struct

+ APIKeys APIKeyStore

+ AllowedCIDRs []string

+ AuthToken string

+ Fleet *orchestrator.FleetManager

+ MetricsRequestDuration *prometheus.HistogramVec

+ MetricsRequestsInFlight prometheus.Gauge

+ MetricsRequestsTotal *prometheus.CounterVec

+ NewProvider ProviderFactory

+ OnAuthFailure AuthFailureFunc

+ OnIPReject IPRejectFunc

+ Resolver Resolver

+ SecureCookies bool

+ func (h *Handler) Router() (http.Handler, error)

+ type Healthcheck struct

+ CheckTimeout time.Duration

+ Fleet *orchestrator.FleetManager

+ Store orchestrator.StateStore

+ func (h *Healthcheck) Liveness(w http.ResponseWriter, _ *http.Request)

+ func (h *Healthcheck) Readiness(w http.ResponseWriter, r *http.Request)

+ type HostCapacity struct

+ CPUs int

+ RamMB int

+ StorageGB int

+ VMCount int

+ type HostInfo struct

+ Allocated HostCapacity

+ Capacity HostCapacity

+ CreatedAt time.Time

+ ID string

+ LastSeen time.Time

+ Region string

+ State string

+ URL string

+ UpdatedAt time.Time

+ type HostList struct

+ Hosts []HostInfo

+ type IPRejectFunc func(remoteAddr, method, path, requestID string)

+ type InlineResolver struct

+ func (InlineResolver) Resolve(req CreateEnvironmentRequest) ([]byte, error)

+ type Principal struct

+ KeyID string

+ Master bool

+ func PrincipalFromContext(ctx context.Context) (Principal, bool)

+ type ProviderFactory func(url, token string) orchestrator.Provider

+ type RegisterHostRequest struct

+ Capacity HostCapacity

+ ID string

+ Region string

+ Token string

+ URL string

+ type Resolver interface

+ Resolve func(req CreateEnvironmentRequest) ([]byte, error)

+ type ResourceSpec struct

+ CPUs int32

+ MaxRuntimeSeconds int64

+ RamMB int32

+ Region string

+ StorageGB int32

+ type Snapshot struct

+ Comment string

+ CreatedAt time.Time

+ ExportRef string

+ Exports []SnapshotExport

+ ID string

+ LastError string

+ Mode string

+ ParentSnapshotID string

+ RetentionUntil *time.Time

+ SizeBytes int64

+ State string

+ TaskID string

+ TenantID string

+ UpdatedAt time.Time

+ VMID string

+ type SnapshotExport struct

+ Destination string

+ LastError string

+ RequestedAt time.Time

+ Status string

+ UpdatedAt time.Time

+ type SnapshotList struct

+ Snapshots []Snapshot