Genkit JS API reference
    Preparing search index...

    Interface RemoteAgentOptions

    Options for remoteAgent.

    interface RemoteAgentOptions {
        abortUrl?: string;
        getSnapshotUrl?: string;
        headers?:
            | Record<string, string>
            | (() => Record<string, string> | Promise<Record<string, string>>);
        stateManagement?: "client" | "server";
        url: string;
    }
    Index

    Properties

    abortUrl? getSnapshotUrl? headers? stateManagement? url

    Properties

    abortUrl?: string

    Optional. Defaults to ${url}/abort.

    getSnapshotUrl?: string

    Optional. Defaults to ${url}/getSnapshot.

    headers?:
        | Record<string, string>
        | (() => Record<string, string> | Promise<Record<string, string>>)

    Optional. Static headers, or a function called per request.

    stateManagement?: "client" | "server"

    Optional. Declares server- vs client-managed state; inferred otherwise.

    url: string

    Required. The agent endpoint.

    Settings

    Member Visibility

    On This Page

    Properties