Airtop
Node: airtop · Full type: n8n-nodes-base.airtop · Version: 1.1
Credentials
airtopApi (alias: @airtop)
CREDENTIAL @airtop = airtopApi "My Airtop"
Operations
Resource: agent
run
| Parameter |
Type |
Default |
Details |
agentId |
resourceLocator |
{...} |
required; modes: list, id |
agentParameters |
resourceMapper |
{...} |
|
awaitExecution |
boolean |
true |
|
timeout |
number |
600 |
|
query
| Parameter |
Type |
Default |
Details |
sessionMode |
options |
"existing" |
new, existing |
prompt |
string |
"" |
required |
additionalFields |
collection |
{} |
keys: outputSchema, parseJsonOutput, includeVisualAnalysis |
getPaginated
| Parameter |
Type |
Default |
Details |
sessionMode |
options |
"existing" |
new, existing |
prompt |
string |
"" |
required |
additionalFields |
collection |
{} |
keys: outputSchema, parseJsonOutput, interactionMode, paginationMode |
scrape
| Parameter |
Type |
Default |
Details |
sessionMode |
options |
"existing" |
new, existing |
Resource: file
deleteFile
| Parameter |
Type |
Default |
Details |
fileId |
string |
"" |
required |
get
| Parameter |
Type |
Default |
Details |
fileId |
string |
"" |
required |
outputBinaryFile |
boolean |
false |
|
getMany
| Parameter |
Type |
Default |
Details |
returnAll |
boolean |
false |
|
limit |
number |
10 |
|
sessionIds |
string |
"" |
|
outputSingleItem |
boolean |
true |
|
load
| Parameter |
Type |
Default |
Details |
sessionId |
string |
"={{ $json["sessionId"] }}" |
required |
windowId |
string |
"={{ $json["windowId"] }}" |
required |
fileId |
string |
"" |
required |
elementDescription |
string |
"" |
|
includeHiddenElements |
boolean |
true |
|
upload
| Parameter |
Type |
Default |
Details |
sessionId |
string |
"={{ $json["sessionId"] }}" |
required |
windowId |
string |
"={{ $json["windowId"] }}" |
required |
fileName |
string |
"" |
required |
fileType |
options |
"customer_upload" |
browser_download, screenshot, video, customer_upload |
source |
options |
"url" |
url, binary |
binaryPropertyName |
string |
"data" |
required |
url |
string |
"" |
required |
triggerFileInputParameter |
boolean |
true |
|
elementDescription |
string |
"" |
|
includeHiddenElements |
boolean |
true |
|
Resource: interaction
click
| Parameter |
Type |
Default |
Details |
elementDescription |
string |
"" |
required |
clickType |
options |
"click" |
click, doubleClick, rightClick |
additionalFields |
collection |
{} |
keys: visualScope, waitForNavigation |
fill
| Parameter |
Type |
Default |
Details |
formData |
string |
"" |
required |
hover
| Parameter |
Type |
Default |
Details |
elementDescription |
string |
"" |
required |
additionalFields |
collection |
{} |
keys: visualScope, waitForNavigation |
| Parameter |
Type |
Default |
Details |
scrollingMode |
options |
"automatic" |
required; automatic, manual |
scrollToElement |
string |
"" |
required |
scrollToEdge |
fixedCollection |
{} |
groups: edgeValues |
scrollBy |
fixedCollection |
{} |
groups: scrollValues |
scrollWithin |
string |
"" |
|
additionalFields |
collection |
{} |
keys: visualScope, waitForNavigation |
type
| Parameter |
Type |
Default |
Details |
text |
string |
"" |
required |
pressEnterKey |
boolean |
false |
|
elementDescription |
string |
"" |
|
additionalFields |
collection |
{} |
keys: visualScope, waitForNavigation |
Resource: session
create
| Parameter |
Type |
Default |
Details |
profileName |
string |
"" |
|
saveProfileOnTermination |
boolean |
false |
|
record |
boolean |
false |
|
timeoutMinutes |
number |
10 |
|
proxy |
options |
"none" |
none, integrated, proxyUrl |
proxyConfig |
collection |
{...} |
keys: country, sticky |
proxyUrl |
string |
"" |
|
additionalFields |
collection |
{} |
keys: solveCaptcha, extensionIds |
save
| Parameter |
Type |
Default |
Details |
sessionId |
string |
"={{ $json["sessionId"] }}" |
required |
profileName |
string |
"" |
required |
terminate
| Parameter |
Type |
Default |
Details |
sessionId |
string |
"={{ $json["sessionId"] }}" |
required |
waitForDownload
| Parameter |
Type |
Default |
Details |
sessionId |
string |
"={{ $json["sessionId"] }}" |
required |
additionalFields |
collection |
{} |
keys: timeout |
Resource: window
close
| Parameter |
Type |
Default |
Details |
windowId |
string |
"={{ $json["windowId"] }}" |
required |
create
| Parameter |
Type |
Default |
Details |
url |
string |
"" |
|
getLiveView |
boolean |
false |
|
includeNavigationBar |
boolean |
false |
|
screenResolution |
string |
"" |
|
disableResize |
boolean |
false |
|
additionalFields |
collection |
{} |
keys: waitUntil |
getLiveView
| Parameter |
Type |
Default |
Details |
windowId |
string |
"={{ $json["windowId"] }}" |
required |
additionalFields |
collection |
{} |
keys: includeNavigationBar, screenResolution, disableResize |
list
No additional parameters.
load
| Parameter |
Type |
Default |
Details |
windowId |
string |
"={{ $json["windowId"] }}" |
required |
url |
string |
"" |
required |
additionalFields |
collection |
{} |
keys: waitUntil |
takeScreenshot
| Parameter |
Type |
Default |
Details |
windowId |
string |
"={{ $json["windowId"] }}" |
required |
outputImageAsBinary |
boolean |
false |
|
Common Parameters
| Parameter |
Type |
Default |
Details |
sessionId |
string |
"={{ $json["sessionId"] }}" |
required |
windowId |
string |
"={{ $json["windowId"] }}" |
required |
url |
string |
"" |
required |
profileName |
string |
"" |
|
autoTerminateSession |
boolean |
true |
|
Parameter Details
proxyConfig children:
| Parameter |
Type |
Default |
Details |
country |
options |
"US" |
AF, AX, AL, DZ, AS, AD, AO, AI, ... (249 total) |
sticky |
boolean |
true |
|
additionalFields children:
| Parameter |
Type |
Default |
Details |
solveCaptcha |
boolean |
false |
|
extensionIds |
string |
"" |
|
scrollToEdge children:
edgeValues group:
| Parameter |
Type |
Default |
Details |
yAxis |
options |
"" |
`,top,bottom` |
xAxis |
options |
"" |
`,left,right` |
scrollBy children:
scrollValues group:
| Parameter |
Type |
Default |
Details |
yAxis |
string |
"" |
|
xAxis |
string |
"" |
|
Example
NODE "airtop" @airtop AS "Airtop" {
resource: "agent",
operation: "get",
sessionId: {{ $json.sessionId }},
windowId: {{ $json.windowId }},
fileId: {{ $json.fileId }}
}