ADK for TypeScript: API Reference
    Preparing search index...

    Interface RemoteAgentConfig

    Configuration options for RemoteAgent.

    interface RemoteAgentConfig {
        afterAgentCallback?: AfterAgentCallback;
        beforeAgentCallback?: BeforeAgentCallback;
        description?: string;
        fetchImpl?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        inputSchema?: SchemaLike;
        isolationScope?: string
        | true;
        name: string;
        outputSchema?: SchemaLike;
        parentAgent?: BaseAgent<BaseAgentConfig>;
        rerunOnResume?: boolean;
        retryConfig?: RetryConfig;
        stateSchema?: SchemaLike;
        subAgents?: undefined;
        timeout?: number;
        timeoutMs?: number;
        url: string;
        waitForOutput?: boolean;
    }

    Hierarchy (View Summary)

    afterAgentCallback?: AfterAgentCallback
    beforeAgentCallback?: BeforeAgentCallback
    description?: string

    Human-readable description (used when a node is exposed as a tool).

    fetchImpl?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Optional custom fetch implementation used for HTTP requests.

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    inputSchema?: SchemaLike

    Optional schema validating the node input (Zod v3/v4 or genai Schema).

    isolationScope?: string | true

    Runs this node's subtree in an isolated conversation scope: an agent inside it sees only session events carrying the same scope, plus untagged ones. true derives a scope per node run; a string is an explicit shared tag.

    name: string

    Canonical, unique-within-a-graph node name.

    outputSchema?: SchemaLike

    Optional schema validating the node output (Zod v3/v4 or genai Schema).

    parentAgent?: BaseAgent<BaseAgentConfig>
    rerunOnResume?: boolean

    If true, the node re-executes when a workflow resumes even if it already completed in a prior turn. Default false.

    retryConfig?: RetryConfig

    Optional retry configuration for transient failures.

    stateSchema?: SchemaLike

    Optional schema validating relevant session state (Zod v3/v4 or genai Schema).

    subAgents?: undefined

    Sub-agents are disabled on RemoteAgent.

    timeout?: number

    Maximum time, in seconds, for this node to complete.

    timeoutMs?: number

    Request timeout in milliseconds; defaults to 120_000 (120 seconds).

    url: string

    Remote HTTP endpoint URL that accepts an invocation payload and returns a JSON array of events.

    waitForOutput?: boolean

    If true, the node only produces its output once all of its predecessors have triggered it (fan-in / join semantics). Default false.

    Properties