Create Browser Session
airtop.create_session
ActionBusiness appsconnection required
Calls the Airtop API with the connection's credentials.
Start a cloud browser session that later Airtop nodes act inside.
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, none 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 |
|---|---|---|---|---|---|
profile_name Name of a saved Airtop profile to load, so the browser starts already signed in to the sites that profile was saved from. | string | No | — | — | — |
solve_captcha Let Airtop attempt captcha challenges the pages present during the session. | boolean | No | false | — | — |
timeout_minutes Minutes of inactivity after which Airtop ends the session by itself. Airtop defaults to 10 when this is left blank. | number | No | — | ≥ 1 | — |
extension_ids Chrome Web Store extension ids to load into the browser. | array | No | — | array of string | ["gighmmpiobklfepjocnamgkkbiglidom"] |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"extension_ids": [
"gighmmpiobklfepjocnamgkkbiglidom"
],
"solve_captcha": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The session id; every later Airtop node needs it. | string | — |
status The session's state, such as initializing or running. | string | — |
date_created When the session was started, as an ISO-8601 timestamp. | string | — |
last_activity When the session last saw activity, as ISO-8601. | string | — |
current_usage How many minutes this session has used so far. | number | — |
profile_id Id of a profile persisted from this session, if any. | string | — |
cdp_url Chrome DevTools Protocol URL for the session; it needs the same bearer key. | string | — |
cdp_ws_url WebSocket URL for CDP automation frameworks such as Puppeteer or Playwright. | string | — |
chromedriver_url WebSocket URL for WebDriver automation frameworks such as Selenium. | string | — |
warnings Non-fatal problems Airtop reported about the session. | array | — |
{
"cdp_url": "",
"cdp_ws_url": "",
"chromedriver_url": "",
"current_usage": 0,
"date_created": "",
"id": "",
"last_activity": "",
"profile_id": "",
"status": "",
"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.
See Create Browser Session 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.