Skip to main content
Airtop logo
  • Category: web scraping & browser
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: AIRTOP
  • Version: 20261101_00

Tools

Slug: AIRTOP_CLICK_ELEMENTUse Airtop AI to locate and click an element from a natural-language description, consuming credits and potentially triggering irreversible external effects such as submitting a form or placing an order. Successful and partial responses include status, credit usage, warnings, and errors; failures raise an error.

Input Parameters

string
required
Window containing the target element.
string ("click" | "doubleClick" | "rightClick")
Mouse click behavior: a left click, double click, or right click.
string
required
Running session that owns the window.
string
Optional caller correlation ID returned in Airtop response metadata.
string
required
Specific natural-language description of the element to click.
boolean
Wait for navigation after clicking. Enable this for links and submit controls that change pages.
integer
Credit threshold checked periodically by Airtop. This is not a hard cap; omit it to use Airtop’s default. Setting 0 disables this protection and is not recommended.
integer
Runtime threshold checked periodically by Airtop. This is not a hard deadline; omit it to use Airtop’s default. Setting 0 disables this protection and is not recommended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRTOP_CLOSE_WINDOWClose one browser window without terminating its Airtop session.

Input Parameters

string
required
Airtop window ID to close.
string
required
Running session that owns the window.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRTOP_CREATE_SESSIONCreate an Airtop browser session and wait until it is running. Sessions are billed in 30-second increments, so terminate them promptly when work is complete.

Input Parameters

string
Optional Airtop integrated or custom proxy configuration. Use true for Airtop’s default integrated proxy, a proxy string/object for one relay, or domain-specific proxy rules. Availability depends on the account plan.
boolean
Whether to record the session; recording can be unavailable on free plans.
string
Saved Airtop profile to load into the session.
array
Google Web Store extension IDs to load.
boolean
Whether Airtop should automatically solve CAPTCHA challenges.
integer
Idle timeout in minutes before Airtop terminates the session.
integer
Maximum wall-clock time to poll for running status before failing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRTOP_CREATE_WINDOWCreate a browser window in a running Airtop session and load an initial URL. If no URL is supplied, Airtop loads https://www.google.com.

Input Parameters

string
Initial absolute URL to load. If omitted, Airtop loads https://www.google.com.
string
required
Running session that will own the window.
string ("load" | "domContentLoaded" | "complete" | "noWait")
Page loading event to wait for before returning.
string
Fixed live-view resolution in WIDTHxHEIGHT format.
integer
Maximum wait for the selected loading event, in seconds. Reaching the timeout produces a warning rather than failing window creation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRTOP_LIST_SESSIONSList Airtop browser sessions, optionally filtering by IDs or status. Use this to discover sessions or check the current state of a known session.

Input Parameters

integer
Maximum number of sessions to return in this page.
string ("awaitingCapacity" | "initializing" | "running" | "ended" | "completed" | "cancelled" | "all")
Return only sessions with this status.
string
Continuation cursor from a previous response. Omit for the first page and pass it back unchanged to fetch the next page.
string
Comma-separated session IDs to return. Omit to list sessions without an ID filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRTOP_LIST_WINDOWSList all browser windows in a running Airtop session, including their IDs, current URLs, and titles when available.

Input Parameters

string
required
Running Airtop session whose browser windows to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRTOP_QUERY_PAGEAsk Airtop AI a question about a page or extract structured page content. This operation consumes Airtop credits; the response reports credits_used, and cost/time thresholds cancel work after periodically checked thresholds are exceeded.

Input Parameters

string
required
Question or extraction instruction for the current page. Include desired bounds and output details.
string
required
Window whose current page to query.
string
required
Running session that owns the window.
object
Optional JSON Schema for structured model output. It is serialized into Airtop’s configuration.outputSchema string.
string
Optional caller correlation ID returned in response metadata.
integer
Credit threshold checked periodically by Airtop. It is not a hard cap; omit it for Airtop’s default. Setting 0 disables this protection and is not recommended.
integer
Runtime threshold in seconds checked periodically by Airtop. It is not a hard deadline; omit it for Airtop’s default. Setting 0 disables this protection and is not recommended.
Attempt pagination, load-more controls, or infinite scrolling. This can substantially increase cost and execution time; bound the work in the prompt and thresholds.
string ("auto" | "disabled" | "enabled")
Whether Airtop should add screenshot-based analysis. Enabling it can increase credit use and execution time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRTOP_TERMINATE_SESSIONTerminate an Airtop session and all of its windows. Use promptly after browser work to stop time-based session billing.

Input Parameters

string
required
Session ID to terminate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRTOP_TYPE_TEXTUse Airtop AI to type text into an input, consuming credits; enabling Enter can submit forms or trigger external effects. Successful and partial responses include status, usage, warnings, and errors; failures raise an error.

Input Parameters

string
required
Text to type into the target input.
string
required
Window containing the target input.
string
required
Running session that owns the window.
boolean
Press Tab after typing to move focus. If Enter is also enabled, Airtop presses Tab after Enter.
boolean
Press Enter after typing. This can submit a form or trigger another irreversible external action.
boolean
Clear an active HTML input before typing.
string
Optional caller correlation ID returned in Airtop response metadata.
string
Natural-language description of the target input. Omit only when the intended field is already active and unambiguous.
boolean
Wait for navigation after typing or a configured key press.
integer
Credit threshold checked periodically by Airtop. It is not a hard cap; omit it to use Airtop’s default. Setting 0 disables this safeguard and is not recommended.
integer
Runtime threshold in seconds checked periodically by Airtop. It is not a hard deadline; omit it to use Airtop’s default. Setting 0 disables this safeguard and is not recommended.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not