Skip to main content

Documentation Index

Fetch the complete documentation index at: https://relevanceai.com/docs/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 Information & Monitoring tool steps allow you to extract information from web pages, capture visual representations, and monitor pages for specific conditions.

​
Add the ‘Airtop - Query Page’ Tool step

You can add the ‘Airtop - Query Page’ Tool step to your Tool by:
  1. Creating a new Tool, then clicking + Add Step
  2. Searching for and adding the ‘Airtop - Query 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. Prompt to query the page (Required): Enter a natural language prompt describing what information you want to extract from the page (e.g., “extract all product names and prices”). Type {{ to select a variable.
  7. Use paginated extraction (Optional): Check this box if the page contains paginated content and you want to extract data from multiple pages automatically.
  8. Output JSON schema (Optional): Provide a JSON schema (as a string) describing the structure you want returned. When set, Airtop returns structured JSON matching the schema instead of free-form text. Airtop requires draft-07 — include "$schema": "http://json-schema.org/draft-07/schema#" at the top of your schema, or the request will fail with HTTP 422.
  9. Clicking Run step to test out the Tool
The step extracts information from the page based on your prompt. The extracted data is returned and can be used in subsequent steps. When ‘Output JSON schema’ is set, the output is a structured JSON object matching the schema, which is useful when downstream steps expect a consistent shape.

​
Add the ‘Airtop - Screenshot Page’ Tool step

You can add the ‘Airtop - Screenshot Page’ Tool step to your Tool by:
  1. Creating a new Tool, then clicking + Add Step
  2. Searching for and adding the ‘Airtop - Screenshot 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. Capture scope (Optional): Choose what to capture. viewport captures only what’s currently visible, page captures the entire scrollable page in one shot, scan performs a scroll-based capture for sites that don’t render correctly with page, and auto lets Airtop choose. Defaults to auto.
  7. Response format from Airtop (Optional): How Airtop returns the raw screenshot before Relevance re-hosts it. base64 returns inline image data; url returns a signed download URL from Airtop’s storage. Either way, the step returns a Relevance-hosted URL. Defaults to base64 for viewport scope and url for full-page scopes.
  8. Max scan scrolls (Optional): Scan scope only. Maximum number of scrolls performed while capturing. Defaults to 50.
  9. Scan scroll delay (ms) (Optional): Scan scope only. Delay in milliseconds between scrolls. Defaults to 1000.
  10. Overlap percentage (Optional): Percentage of overlap between captured chunks, between 0 and 100. Defaults to 30.
  11. Partition direction (Optional): How the screenshot is split into chunks: vertical (default, recommended for most pages), horizontal (for very wide pages), or bidirectional.
  12. Clicking Run step to test out the Tool
The step returns screenshot_url (the first chunk, kept for backward compatibility) and screenshot_urls (an array of every chunk, all re-hosted on Relevance storage). For scope: viewport there is one chunk; for scope: page and scope: scan there may be several depending on page dimensions and partition direction.

​
Add the ‘Airtop - Monitor Page for Condition’ Tool step

You can add the ‘Airtop - Monitor Page for Condition’ Tool step to your Tool by:
  1. Creating a new Tool, then clicking + Add Step
  2. Searching for and adding the ‘Airtop - Monitor Page for Condition’ 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. Condition Description (Required): Enter a description of the condition you want to monitor (e.g., “when the submit button becomes visible” or “when the text ‘Success’ appears on the page”). Type {{ to select a variable.
  7. Timeout Seconds (Optional): Enter the maximum time in seconds to wait for the condition to be met. If the condition is not met within this time, the step will fail.
  8. Check Interval Seconds (Optional): Enter how frequently (in seconds) to check for the condition. Smaller intervals check more frequently but may use more resources.
  9. Clicking Run step to test out the Tool
The step continuously monitors the page for the specified condition. Once the condition is met (or the timeout is reached), the step completes. This is useful for waiting for dynamic content to load or for specific page states to occur.

​
Common use cases

  • Extracting data from web pages for processing or storage
  • Capturing a full-page screenshot as visual proof of automation actions
  • Waiting for dynamic content to load before proceeding with automation
  • Monitoring pages for specific states or changes

​
Frequently asked questions (FAQs)

Yes. Every chunk is re-hosted on Relevance storage and returned as a URL in screenshot_urls. Pass an entry to any step that accepts an image URL.
Use viewport for the visible area only — fastest and always one chunk. Use page for the entire scrollable content in one Airtop call. Use scan for sites that don’t render correctly with page (typically infinite-scroll or lazy-loaded pages); scan performs a scroll-based capture and returns one chunk per scroll position.
scope: page and scope: scan can return more than one chunk depending on page dimensions and the partition direction. screenshot_url always points to the first chunk for backward compatibility; iterate over screenshot_urls to access them all.
Common conditions include element visibility, text content, and element count.