Scrape Page Content
airtop.scrape_content
ActionBusiness appsconnection required
Calls the Airtop API with the connection's credentials.
Read the whole page in a window back as text.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Airtop
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
session_id The session id returned by airtop.create_session. | string | Yes | — | — | 6aac6f73-bd89-4a76-ab32-5a6c422e8b0b |
window_id The window id returned by airtop.create_window. | string | Yes | — | — | 0334da2a-91b0-42c5-6156-76a5eba87430 |
cost_threshold_credits Cancel the operation once it has spent about this many Airtop credits. Leave blank for Airtop's default; 0 disables the threshold entirely. | number | No | — | ≥ 0 | — |
time_threshold_seconds Cancel the operation once it has run for about this many seconds. Leave blank for Airtop's default; 0 disables the threshold entirely. | number | No | — | ≥ 0 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"session_id": "6aac6f73-bd89-4a76-ab32-5a6c422e8b0b",
"window_id": "0334da2a-91b0-42c5-6156-76a5eba87430"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
title The title of the page that was scraped. | string | — |
text The page's content as text. | string | — |
content_type The MIME type of that content, usually text/plain but not always. | string | — |
selected_text Any text highlighted in the window. | string | — |
status Airtop's outcome for the scrape: success, partial or failure. | string | — |
request_id Airtop's id for this request, for their support. | string | — |
usage What the scrape cost, as Airtop reported it. | object | — |
warnings Non-fatal problems Airtop reported about the scrape. | array | — |
{
"content_type": "",
"request_id": "",
"selected_text": "",
"status": "",
"text": "",
"title": "",
"usage": {},
"warnings": []
}Notes
- An Airtop session is a live cloud browser and bills for as long as it runs: end it with airtop.terminate_session, and set timeout_minutes as a backstop.
- This call is billed in Airtop credits. cost_threshold_credits and time_threshold_seconds cancel it if it runs long; 0 disables a threshold.
See Scrape Page Content run in a workflow.
In a technical demo we add the Airtop connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.