Tap on device
Tap an interactive element by { index } (1-based, from
/state.a11yTree) OR an explicit { x, y } coordinate. Supplying
both is accepted and index wins. At least one of the two forms is
required: supplying neither is a 400, and x without y is also a
400 when no index is supplied (with index, any coordinates are
accepted and ignored).
Optionally include capture: true | CaptureOptions to
return a fresh element tree + screen dimensions in the same
round trip.
curl --request POST \
--url https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/tap \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"index": 2,
"x": 123,
"y": 123,
"stealth": true,
"capture": true
}
'const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({index: 2, x: 123, y: 123, stealth: true, capture: true})
};
fetch('https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/tap', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/tap"
payload = {
"index": 2,
"x": 123,
"y": 123,
"stealth": True,
"capture": True
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"exit_code": 123,
"status": "<string>",
"commandId": "<string>",
"durationMs": 123,
"message": "<string>",
"resolved": {
"x": 123,
"y": 123,
"index": 123
},
"capture": {
"failed": true,
"error": "<string>",
"elements": "<string>",
"element_count": 1,
"screen_dimensions": {
"width": 1,
"height": 1
},
"screenshot_url": "<string>"
}
}{
"error": "validation_error",
"details": {}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Workspace API key, created in the dashboard under Settings → API Keys.
Path Parameters
Workspace UUID. Caller must have access.
Device id (paired into the workspace).
Body
- Option 1
- Option 2
Provide index, or x+y, or both. At least one form is required:
supplying neither is a 400, and x without y is a 400 only when
no index is supplied. When both forms are supplied index wins
and the coordinates are ignored.
1-based interactive element index from /state.a11yTree.
x >= 1Pixel x-coordinate (alternative to index).
Pixel y-coordinate (alternative to index).
Inject this tap the way a person would: the press held 45–110 ms
instead of a single frame, and the point nudged by up to 2 px.
Returns 412 unsupported_stealth_input when the phone's agent
cannot do it; it is never silently downgraded.
capture: boolean | CaptureOptions. true captures with
defaults; an object lets the caller override individual knobs.
false or omitted = no capture.
Response
Tap dispatched (capture optional)
0 on success, non-zero on failure. Currently derived from
ok; it does not carry the command's own exit code.
Show child attributes
Show child attributes
Capture payload. All inner fields are optional and present iff the corresponding source was captured:
elements/element_count/screen_dimensions— set iffcapture.uiwas true.screenshot_url— set iffcapture.screenshotwas true.
A screenshot-only capture (no UI) returns just screenshot_url;
a UI-only capture returns the tree + count + dimensions; a full
capture returns everything.
The action has already run when the capture is taken. On a single
action endpoint, a failed capture still returns 200 with
capture: { failed: true, error }, so a retry does not repeat a
non-idempotent action. Inside a chain, a failed capture aborts the
chain with an error instead (see POST …/chain).
Show child attributes
Show child attributes
Was this page helpful?
curl --request POST \
--url https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/tap \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"index": 2,
"x": 123,
"y": 123,
"stealth": true,
"capture": true
}
'const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({index: 2, x: 123, y: 123, stealth: true, capture: true})
};
fetch('https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/tap', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/tap"
payload = {
"index": 2,
"x": 123,
"y": 123,
"stealth": True,
"capture": True
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"exit_code": 123,
"status": "<string>",
"commandId": "<string>",
"durationMs": 123,
"message": "<string>",
"resolved": {
"x": 123,
"y": 123,
"index": 123
},
"capture": {
"failed": true,
"error": "<string>",
"elements": "<string>",
"element_count": 1,
"screen_dimensions": {
"width": 1,
"height": 1
},
"screenshot_url": "<string>"
}
}{
"error": "validation_error",
"details": {}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}