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

    Interface RequestInputParams

    Parameters for constructing a RequestInput.

    interface RequestInputParams {
        interruptId?: string;
        message?: string;
        payload?: unknown;
        responseSchema?: SchemaLike;
    }

    Properties

    interruptId?: string

    The interrupt id (usually a function-call id). Auto-generated if omitted.

    message?: string

    A message to display to the user when requesting input.

    payload?: unknown

    Custom payload provided for resuming.

    responseSchema?: SchemaLike

    The expected shape of the reply (Zod v3/v4 or genai Schema).

    It tells a client what to collect — the dev UI renders a form from it — and a structured reply is checked against it on resume. Nothing coerces a human's answer into the shape: a plain-text reply is routed to the interrupt as-is and is not checked, so put an agent node after the pause if you need free text normalized.

    Properties