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

    Interface CreateSessionOptions

    Options accepted by createSession(agentType, options?).

    interface CreateSessionOptions {
        additionalInstructions?: string;
        cwd?: string;
        env?: Record<string, string>;
        mcpServers?: McpServerConfig[];
        skipOsInstructions?: boolean;
    }
    Index

    Properties

    additionalInstructions?: string

    Additional instructions appended to the base OS instructions.

    cwd?: string

    Working directory for the agent session inside the VM. Defaults to /workspace.

    env?: Record<string, string>

    Environment variables passed to the agent process (e.g. API keys).

    mcpServers?: McpServerConfig[]

    MCP servers made available to the agent during the session.

    skipOsInstructions?: boolean

    Skip OS instructions injection entirely (default false).