agentOS API Reference - v0.2.0-rc.3
    Preparing search index...

    Interface AgentOsActorConfigInput<TConnParams>

    Input config passed to agentOS(...).

    The VM option fields live at the TOP LEVEL (no nested options key), so callers write agentOS({ software: [...], additionalInstructions: "..." }).

    interface AgentOsActorConfigInput<TConnParams = undefined> {
        __connParams?: TConnParams;
        additionalInstructions?: string;
        allowedNodeBuiltins?: string[];
        bindings?: unknown[];
        limits?: unknown;
        loopbackExemptPorts?: number[];
        mounts?: unknown[];
        onPermissionRequest?: (
            sessionId: string,
            request: PermissionRequest,
        ) => void | Promise<void>;
        onSessionEvent?: (
            sessionId: string,
            event: JsonRpcNotification,
        ) => void | Promise<void>;
        permissions?: unknown;
        preview?: {
            defaultExpiresInSeconds?: number;
            maxExpiresInSeconds?: number;
        };
        rootFilesystem?: unknown;
        sidecar?: unknown;
        software?: unknown[];
    }

    Type Parameters

    • TConnParams = undefined

    Hierarchy (View Summary)

    Index

    Properties

    __connParams? additionalInstructions? allowedNodeBuiltins? bindings? limits? loopbackExemptPorts? mounts? onPermissionRequest? onSessionEvent? permissions? preview? rootFilesystem? sidecar? software?

    Properties

    Optional__connParams

    __connParams?: TConnParams
    additionalInstructions?: string

    Additional instructions appended to the base OS instructions.

    allowedNodeBuiltins?: string[]

    Node.js builtins the guest is allowed to import.

    bindings?: unknown[]

    Bindings exposed to agents as CLI commands inside the VM.

    limits?: unknown

    Per-VM resource limits.

    loopbackExemptPorts?: number[]

    Ports exempt from the loopback-only network restriction.

    mounts?: unknown[]

    Host-backed mounts exposed inside the VM.

    onPermissionRequest?: (
        sessionId: string,
        request: PermissionRequest,
    ) => void | Promise<void>
    onSessionEvent?: (
        sessionId: string,
        event: JsonRpcNotification,
    ) => void | Promise<void>
    permissions?: unknown

    Permission policy applied to the VM.

    preview?: { defaultExpiresInSeconds?: number; maxExpiresInSeconds?: number }
    rootFilesystem?: unknown

    Root filesystem configuration / snapshot.

    sidecar?: unknown

    Low-level runtime configuration.

    software?: unknown[]

    Software packages to install in the VM. Pass the imported packages directly (e.g. software: [common, pi]); kept loosely typed so any software package import type-checks.

    Settings

    Member Visibility

    On This Page

    Properties