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

    Interface BaseAgentConfig

    The config of a base agent.

    Extends BaseNodeConfig, so every agent also accepts the node-level options — retryConfig, timeout, inputSchema, outputSchema, stateSchema, rerunOnResume, waitForOutput — which apply when the agent runs inside a workflow.

    interface BaseAgentConfig {
        afterAgentCallback?: AfterAgentCallback;
        beforeAgentCallback?: BeforeAgentCallback;
        description?: string;
        inputSchema?: SchemaLike;
        isolationScope?: string | true;
        name: string;
        outputSchema?: SchemaLike;
        parentAgent?: BaseAgent<BaseAgentConfig>;
        rerunOnResume?: boolean;
        retryConfig?: RetryConfig;
        stateSchema?: SchemaLike;
        subAgents?: BaseAgent<BaseAgentConfig>[];
        timeout?: number;
        waitForOutput?: boolean;
    }

    Hierarchy (View Summary)

    Properties

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

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

    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?: BaseAgent<BaseAgentConfig>[]
    timeout?: number

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

    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