AAI SDK
    Preparing search index...

    Type Alias Runtime

    Runtime: AgentRuntime & {
        executeTool: ExecuteTool;
        toolSchemas: ToolSchema[];
        createSession(
            opts: {
                agent: string;
                client: ClientSink;
                id: string;
                skipGreeting?: boolean;
            },
        ): SessionCore;
    }

    The agent runtime returned by createRuntime.

    Satisfies AgentRuntime for use by transport code, and also exposes lower-level helpers (executeTool, toolSchemas, createSession) for testing and advanced usage.

    Type Declaration

    • executeTool: ExecuteTool

      Execute a named tool with the given args, returning a JSON result string.

    • toolSchemas: ToolSchema[]

      Tool schemas registered with the S2S API (custom + built-in).

    • createSession: function
      • createSession(
            opts: {
                agent: string;
                client: ClientSink;
                id: string;
                skipGreeting?: boolean;
            },
        ): SessionCore

        Create a new voice session for a connected client (lower-level than startSession).

        Parameters

        • opts: { agent: string; client: ClientSink; id: string; skipGreeting?: boolean }

        Returns SessionCore

    Settings
    Member Visibility