nodes/generated

Interface AirtopNodeParameters

Source


interface AirtopNodeParameters {
    additionalFields?:
        | { extensionIds?: string; solveCaptcha?: boolean }
        | { timeout?: number }
        | {
            waitUntil?:
                | "load"
                | "domContentLoaded"
                | "complete"
                | "noWait";
        }
        | {
            disableResize?: boolean;
            includeNavigationBar?: boolean;
            screenResolution?: string;
        }
        | {
            waitUntil?: | "load"
            | "domContentLoaded"
            | "complete"
            | "noWait";
        }
        | {
            interactionMode?: | "auto"
            | "accurate"
            | "cost-efficient";
            outputSchema?: string;
            paginationMode?: | "auto"
            | "paginated"
            | "infinite-scroll";
            parseJsonOutput?: boolean;
        }
        | {
            includeVisualAnalysis?: boolean;
            outputSchema?: string;
            parseJsonOutput?: boolean;
        }
        | {
            visualScope?: | "auto"
            | "viewport"
            | "page"
            | "scan";
            waitForNavigation?: | "load"
            | "domcontentloaded"
            | "networkidle0"
            | "networkidle2";
        };
    agentId?: { mode: "id"
    | "list"; value: string };
    autoTerminateSession?: boolean;
    awaitExecution?: boolean;
    binaryPropertyName?: string;
    clickType?: "click" | "doubleClick" | "rightClick";
    disableResize?: boolean;
    elementDescription?: string;
    fileId?: string;
    fileName?: string;
    fileType?:
        | "browser_download"
        | "screenshot"
        | "video"
        | "customer_upload";
    formData?: string;
    getLiveView?: boolean;
    includeHiddenElements?: boolean;
    includeNavigationBar?: boolean;
    limit?: number;
    operation?: | "create"
    | "get"
    | "list"
    | "getMany"
    | "run"
    | "save"
    | "terminate"
    | "waitForDownload"
    | "close"
    | "getLiveView"
    | "load"
    | "takeScreenshot"
    | "deleteFile"
    | "upload"
    | "query"
    | "getPaginated"
    | "scrape"
    | "click"
    | "fill"
    | "hover"
    | "scroll"
    | "type";
    outputBinaryFile?: boolean;
    outputImageAsBinary?: boolean;
    outputSingleItem?: boolean;
    pressEnterKey?: boolean;
    profileName?: string;
    prompt?: string;
    proxy?: "none"
    | "integrated"
    | "proxyUrl";
    proxyConfig?: {
        country?:
            | "AF"
            | "AX"
            | "AL"
            | "DZ"
            | "AS"
            | "AD"
            | "AO"
            | "AI"
            | "AQ"
            | "AG"
            | "AR"
            | "AM"
            | "AW"
            | "AU"
            | "AT"
            | "AZ"
            | "BS"
            | "BH"
            | "BD"
            | "BB"
            | "BY"
            | "BE"
            | "BZ"
            | "BJ"
            | "BM"
            | "BT"
            | "BO"
            | "BQ"
            | "BA"
            | "BW"
            | "BV"
            | "BR"
            | "IO"
            | "BN"
            | "BG"
            | "BF"
            | "BI"
            | "CV"
            | "KH"
            | "CM"
            | "CA"
            | "KY"
            | "CF"
            | "TD"
            | "CL"
            | "CN"
            | "CX"
            | "CC"
            | "CO"
            | "KM"
            | "CG"
            | "CD"
            | "CK"
            | "CR"
            | "CI"
            | "HR"
            | "CU"
            | "CW"
            | "CY"
            | "CZ"
            | "DK"
            | "DJ"
            | "DM"
            | "DO"
            | "EC"
            | "EG"
            | "SV"
            | "GQ"
            | "ER"
            | "EE"
            | "SZ"
            | "ET"
            | "FK"
            | "FO"
            | "FJ"
            | "FI"
            | "FR"
            | "GF"
            | "PF"
            | "TF"
            | "GA"
            | "GM"
            | "GE"
            | "DE"
            | "GH"
            | "GI"
            | "GR"
            | "GL"
            | "GD"
            | "GP"
            | "GU"
            | "GT"
            | "GG"
            | "GN"
            | "GW"
            | "GY"
            | "HT"
            | "HM"
            | "VA"
            | "HN"
            | "HK"
            | "HU"
            | "IS"
            | "IN"
            | "ID"
            | "IR"
            | "IQ"
            | "IE"
            | "IM"
            | "IL"
            | "IT"
            | "JM"
            | "JP"
            | "JE"
            | "JO"
            | "KZ"
            | "KE"
            | "KI"
            | "KP"
            | "KR"
            | "KW"
            | "KG"
            | "LA"
            | "LV"
            | "LB"
            | "LS"
            | "LR"
            | "LY"
            | "LI"
            | "LT"
            | "LU"
            | "MO"
            | "MG"
            | "MW"
            | "MY"
            | "MV"
            | "ML"
            | "MT"
            | "MH"
            | "MQ"
            | "MR"
            | "MU"
            | "YT"
            | "MX"
            | "FM"
            | "MD"
            | "MC"
            | "MN"
            | "ME"
            | "MS"
            | "MA"
            | "MZ"
            | "MM"
            | "NA"
            | "NR"
            | "NP"
            | "NL"
            | "NC"
            | "NZ"
            | "NI"
            | "NE"
            | "NG"
            | "NU"
            | "NF"
            | "MK"
            | "MP"
            | "NO"
            | "OM"
            | "PK"
            | "PW"
            | "PS"
            | "PA"
            | "PG"
            | "PY"
            | "PE"
            | "PH"
            | "PN"
            | "PL"
            | "PT"
            | "PR"
            | "QA"
            | "RE"
            | "RO"
            | "RU"
            | "RW"
            | "BL"
            | "SH"
            | "KN"
            | "LC"
            | "MF"
            | "PM"
            | "VC"
            | "WS"
            | "SM"
            | "ST"
            | "SA"
            | "SN"
            | "RS"
            | "SC"
            | "SL"
            | "SG"
            | "SX"
            | "SK"
            | "SI"
            | "SB"
            | "SO"
            | "ZA"
            | "GS"
            | "SS"
            | "ES"
            | "LK"
            | "SD"
            | "SR"
            | "SJ"
            | "SE"
            | "CH"
            | "SY"
            | "TW"
            | "TJ"
            | "TZ"
            | "TH"
            | "TL"
            | "TG"
            | "TK"
            | "TO"
            | "TT"
            | "TN"
            | "TR"
            | "TM"
            | "TC"
            | "TV"
            | "UG"
            | "UA"
            | "AE"
            | "GB"
            | "UM"
            | "US"
            | "UY"
            | "UZ"
            | "VU"
            | "VE"
            | "VN"
            | "VG"
            | "VI"
            | "WF"
            | "EH"
            | "YE"
            | "ZM"
            | "ZW";
        sticky?: boolean;
    };
    proxyUrl?: string;
    record?: boolean;
    resource?: | "agent"
    | "extraction"
    | "file"
    | "interaction"
    | "session"
    | "window";
    returnAll?: boolean;
    saveProfileOnTermination?: boolean;
    screenResolution?: string;
    scrollBy?: {
        scrollValues: { xAxis?: string; yAxis?: string };
    };
    scrollingMode?: "manual"
    | "automatic";
    scrollToEdge?: {
        edgeValues: {
            xAxis?: "" | "left" | "right";
            yAxis?: "" | "top" | "bottom";
        };
    };
    scrollToElement?: string;
    scrollWithin?: string;
    sessionId?: string;
    sessionIds?: string;
    sessionMode?: "new"
    | "existing";
    source?: "url" | "binary";
    text?: string;
    timeout?: number;
    timeoutMinutes?: number;
    triggerFileInputParameter?: boolean;
    url?: string;
    windowId?: string;
}

Properties§

§readonly additionalFields?:
    | { extensionIds?: string; solveCaptcha?: boolean }
    | { timeout?: number }
    | {
        waitUntil?:
            | "load"
            | "domContentLoaded"
            | "complete"
            | "noWait";
    }
    | {
        disableResize?: boolean;
        includeNavigationBar?: boolean;
        screenResolution?: string;
    }
    | {
        waitUntil?: | "load"
        | "domContentLoaded"
        | "complete"
        | "noWait";
    }
    | {
        interactionMode?: | "auto"
        | "accurate"
        | "cost-efficient";
        outputSchema?: string;
        paginationMode?: | "auto"
        | "paginated"
        | "infinite-scroll";
        parseJsonOutput?: boolean;
    }
    | {
        includeVisualAnalysis?: boolean;
        outputSchema?: string;
        parseJsonOutput?: boolean;
    }
    | {
        visualScope?: "auto"
        | "viewport"
        | "page"
        | "scan";
        waitForNavigation?:
            | "load"
            | "domcontentloaded"
            | "networkidle0"
            | "networkidle2";
    }

Default: {}

§readonly agentId?: { ... }

The Airtop agent to run. Visit Airtop Agents for more information. Default: {"mode":"list","value":""}

§readonly autoTerminateSession?: boolean

Whether to terminate the session after the operation is complete. When disabled, you must manually terminate the session. By default, idle sessions timeout after 10 minutes Default: true

§readonly awaitExecution?: boolean

Whether to wait for the agent to complete its execution Default: true

§readonly binaryPropertyName?: string

Name of the binary property containing the file data Default: "data"

§readonly clickType?: "click" | "doubleClick" | "rightClick"

The type of click to perform. Defaults to left click. Default: "click"

§readonly disableResize?: boolean

Whether to disable the window from being resized in the Live View

§readonly elementDescription?: string

Optional description of the file input to interact with

§readonly fileId?: string

ID of the file to delete

§readonly fileName?: string

Name for the file to upload. For a session, all files loaded should have unique names.

§readonly fileType?:
    | "browser_download"
    | "screenshot"
    | "video"
    | "customer_upload"

Choose the type of file to upload. Defaults to 'Customer Upload'. Default: "customer_upload"

§readonly formData?: string

The information to fill into the form written in natural language Type options: {"rows":4}

§readonly getLiveView?: boolean

Whether to get the URL of the window's Live View

§readonly includeHiddenElements?: boolean

Whether to include hidden elements in the interaction Default: true

§readonly includeNavigationBar?: boolean

Whether to include the navigation bar in the Live View. When enabled, the navigation bar will be visible allowing you to navigate between pages.

§readonly limit?: number

Max number of results to return Default: 10 Type options: {"minValue":1,"maxValue":100}

§readonly operation?:
    | "create"
    | "get"
    | "list"
    | "getMany"
    | "run"
    | "save"
    | "terminate"
    | "waitForDownload"
    | "close"
    | "getLiveView"
    | "load"
    | "takeScreenshot"
    | "deleteFile"
    | "upload"
    | "query"
    | "getPaginated"
    | "scrape"
    | "click"
    | "fill"
    | "hover"
    | "scroll"
    | "type"

Default: "run"

§readonly outputBinaryFile?: boolean

Whether to output the file in binary format if the file is ready for download

§readonly outputImageAsBinary?: boolean

Whether to output the image as a binary file instead of a base64 encoded string

§readonly outputSingleItem?: boolean

Whether to output one item containing all files or output each file as a separate item Default: true

§readonly pressEnterKey?: boolean

Whether to press the Enter key after typing the text

§readonly profileName?: string

The name of the Airtop profile to load or create

§readonly prompt?: string

The prompt to extract data from the pages Type options: {"rows":4}

§readonly proxy?: "none" | "integrated" | "proxyUrl"

Choose how to configure the proxy for this session Default: "none"

§readonly proxyConfig?: { ... }

The Airtop-provided configuration to use for the proxy Default: {"country":"US","sticky":true}

§readonly proxyUrl?: string

The URL of the proxy to use

§readonly record?: boolean

Whether to record the browser session. More details.

§readonly resource?:
    | "agent"
    | "extraction"
    | "file"
    | "interaction"
    | "session"
    | "window"

Default: "session"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly saveProfileOnTermination?: boolean

Whether to automatically save the Airtop profile for this session upon termination

§readonly screenResolution?: string

The screen resolution of the Live View. Setting a resolution will force the window to open at that specific size.

§readonly scrollBy?: { ... }

The amount to scroll by. When 'Scroll To Edge' is defined, 'Scroll By' action will be executed after 'Scroll To Edge'. Default: {}

§readonly scrollingMode?: "manual" | "automatic"

Choose the mode of scrolling Default: "automatic"

§readonly scrollToEdge?: { ... }

The direction to scroll to. When 'Scroll By' is defined, 'Scroll To Edge' action will be executed first, then 'Scroll By' action. Default: {}

§readonly scrollToElement?: string

A natural language description of the element to scroll to

§readonly scrollWithin?: string

Scroll within an element on the page

§readonly sessionId?: string

The ID of the Session to use Default: "={{ $json["sessionId"] }}"

§readonly sessionIds?: string

Comma-separated list of Session IDs to filter files by. When empty, all files from all sessions will be returned.

§readonly sessionMode?: "new" | "existing"

Choose between creating a new session or using an existing one Default: "existing"

§readonly source?: "url" | "binary"

Source of the file to upload Default: "url"

§readonly text?: string

The text to type into the browser window

§readonly timeout?: number

Timeout in seconds to wait for the agent to finish Default: 600

§readonly timeoutMinutes?: number

Minutes to wait before the session is terminated due to inactivity Default: 10

§readonly triggerFileInputParameter?: boolean

Whether to automatically trigger the file input dialog in the current window. If disabled, the file will only be uploaded to the session without opening the file input dialog. Default: true

§readonly url?: string

Initial URL to load in the window. Defaults to https://www.google.com.

§readonly windowId?: string

The ID of the Window to use Default: "={{ $json["windowId"] }}"