Skip to main content

Documentation Index

Fetch the complete documentation index at: https://relevanceai-changelog-migration.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Before using Airtop browser automation tool steps, you need to configure the Airtop integration. See the Airtop integration setup guide for instructions on connecting your Airtop account.
The Airtop Page Interaction tool steps allow you to interact with web page elements, including clicking buttons, typing text, and scrolling through pages.

Add the ‘Airtop - Click Element’ Tool step

You can add the ‘Airtop - Click Element’ Tool step to your Tool by:
  1. Creating a new Tool, then clicking + Add Step
  2. Searching for and adding the ‘Airtop - Click Element’ Tool step
  3. Clicking ‘Expand’ to see the full Tool step
  4. Window ID (Required): Enter the identifier of the browser window containing the page. Type {{ to select a variable from a previous step.
  5. Session ID (Required): Enter the identifier of the browser session. Type {{ to select a variable.
  6. Element Description (Required): Enter a description of the element you want to click. This can be a natural language description (e.g., “the submit button”) or a CSS selector/XPath. Type {{ to select a variable.
  7. Wait Until Timeout Seconds (Optional): Enter the maximum time in seconds to wait for the element to become clickable.
  8. Wait For Navigation (Optional): Check this box if you want the step to wait for page navigation after clicking the element (useful when clicking links or buttons that cause page loads).
  9. Wait For Navigation Condition (Optional): When ‘Wait For Navigation’ is checked, choose which event to wait for: load, domcontentloaded, networkidle0, or networkidle2. networkidle0 and networkidle2 are the most reliable for detecting that a post-submit page has fully settled.
  10. Clicking Run step to test out the Tool
The step clicks the specified element on the page. If the element is not found or not clickable within the timeout period, the step will fail.

Add the ‘Airtop - Type Text’ Tool step

You can add the ‘Airtop - Type Text’ Tool step to your Tool by:
  1. Creating a new Tool, then clicking + Add Step
  2. Searching for and adding the ‘Airtop - Type Text’ Tool step
  3. Clicking ‘Expand’ to see the full Tool step
  4. Window ID (Required): Enter the identifier of the browser window containing the page. Type {{ to select a variable from a previous step.
  5. Session ID (Required): Enter the identifier of the browser session. Type {{ to select a variable.
  6. Element Description (Required): Enter a description of the input field where you want to type. This can be a natural language description (e.g., “the email input field”) or a CSS selector/XPath. Type {{ to select a variable.
  7. Text to Type (Required): Enter the text you want to type into the element. Type {{ to select a variable, or enter the text directly.
  8. Press Enter Key (Optional): Check this box to press the Enter key after typing the text (useful for submitting forms or triggering search).
  9. Press Tab Key (Optional): Check this box to press the Tab key after typing the text. If both Enter and Tab are enabled, Enter is pressed first. Useful for advancing focus to the next field in a form.
  10. Clear Input Field (Optional): Check this box to clear the input field’s existing value before typing. Use this when filling fields that may already contain a value.
  11. Wait Until Timeout Seconds (Required): Enter the maximum time in seconds to wait for the element to become available.
  12. Wait For Navigation (Optional): Check this box if you want the step to wait for page navigation after typing (useful when typing triggers a page load).
  13. Wait For Navigation Condition (Optional): When ‘Wait For Navigation’ is checked, choose which event to wait for: load, domcontentloaded, networkidle0, or networkidle2.
  14. Clicking Run step to test out the Tool
The step types the specified text into the target element. If the element is not found within the timeout period, the step will fail.

Add the ‘Airtop - Scroll Page’ Tool step

You can add the ‘Airtop - Scroll Page’ Tool step to your Tool by:
  1. Creating a new Tool, then clicking + Add Step
  2. Searching for and adding the ‘Airtop - Scroll Page’ Tool step
  3. Clicking ‘Expand’ to see the full Tool step
  4. Window ID (Required): Enter the identifier of the browser window containing the page. Type {{ to select a variable from a previous step.
  5. Session ID (Required): Enter the identifier of the browser session. Type {{ to select a variable.
  6. X Scroll Amount in pixels (Optional): Number of pixels to scroll horizontally. Positive scrolls right, negative scrolls left. Ignored when ‘Scroll To Element’ is set.
  7. Y Scroll Amount in pixels (Optional): Number of pixels to scroll vertically. Positive scrolls down, negative scrolls up. Ignored when ‘Scroll To Element’ is set.
  8. Scroll To Element (Optional): Natural-language description of what to scroll to (e.g., “the first name field”, “the pricing section”). Takes precedence over the pixel-based X/Y values.
  9. Scroll Within (Optional): Natural-language description of the scrollable container to scroll inside (e.g., “the modal dialog”). If left blank, the entire page is scrolled.
  10. Clicking Run step to test out the Tool
The step scrolls the page (or a named container) by the specified pixel amounts, or scrolls to a described element. Use pixel-based scrolling for precise control such as paging through an infinite scroll list, and ‘Scroll To Element’ when you want to reach a named section without knowing its exact position.

Common use cases

  • Filling out forms automatically, including advancing fields with Tab and clearing pre-filled values before typing
  • Clicking buttons and links to navigate through a website
  • Scrolling to load dynamic content, either by pixel amount or by natural-language description of the target
  • Automating repetitive user interactions

Common errors

This error occurs when trying to click an element that is not currently visible or clickable. You may need to wait for the element to load or scroll to make it visible.

Frequently asked questions (FAQs)

For dynamic content that loads asynchronously, consider using the ‘Airtop - Monitor Page for Condition’ step to wait for elements before interacting with them.
Enable ‘Press Tab Key’ on the ‘Airtop - Type Text’ step after typing into a field. The next focusable element receives focus, which is useful for filling multi-field forms without separately describing each input.
Enable ‘Clear Input Field’ on the ‘Airtop - Type Text’ step. The existing value is cleared before the new text is typed, which is more reliable than simulating Ctrl+A then Delete because it works regardless of the current cursor position or selection state.
Use ‘Scroll To Element’ when you want to reach a named section or element and don’t know its exact pixel position. Use the X/Y pixel inputs when you need precise control over the scroll distance, such as paging through an infinite scroll list a fixed amount at a time.
When ‘Wait For Navigation’ is enabled on the click or type step, the condition controls which page-load event the step waits for. load and domcontentloaded complete earlier, while networkidle0 and networkidle2 wait for network activity to settle and are more reliable for detecting that a post-submit page has fully rendered.