Run a chain of actions
Execute a typed sequence of up to 20 deterministic actions in
order, optionally collecting a UI capture per step. On a Lusor
Phone, an API-key chain meters phone minutes before every step; a
402 or 503 stops the chain before that step reaches the phone.
Capture resolution rules
Per-step capture always wins. Top-level capture supplies
the default policy:
'none'(default) — no capture on any step.'each'— capture on every step.'final'— capture only on the last step.
Step verbs
tap, swipe, type, key, clear, back, home, recent,
start_app, stop_app, screenshot, wait. Each step has the
same params as the corresponding direct-verb route plus an
optional capture override.
Settling
Steps execute back-to-back with no implicit inter-step delay.
Insert wait steps ({ verb: "wait", params: { duration_ms: N } },
0–60000 ms) where the UI needs time to settle — e.g. after a tap
that opens a screen, or before typing into a freshly focused
field. Cumulative wait duration per chain is capped at 120s so
the worst case stays inside the chain timeout.
A step that completes with ok: false does not stop the chain:
the next step still runs, the top-level ok is true only when every
step succeeded, and each step’s ok shows which one failed.
A step that errors instead aborts the chain. This happens when the
phone cannot be reached, when a step’s capture fails, or when
metering refuses a later step (402/503). The response is then
that error alone, with no per-step results, and the steps before it
have already run on the phone. Read the screen before you retry a
chain.
curl --request POST \
--url https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/chain \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"steps": [
{
"verb": "tap",
"params": {
"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({
steps: [
{verb: 'tap', params: {index: 2, x: 123, y: 123, stealth: true}, capture: true}
]
})
};
fetch('https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/chain', 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}/chain"
payload = { "steps": [
{
"verb": "tap",
"params": {
"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,
"steps": [
{
"ok": true,
"exit_code": 123,
"status": "<string>",
"verb": "tap",
"commandId": "<string>",
"durationMs": 123,
"message": "<string>",
"resolved": {
"x": 123,
"y": 123,
"index": 123
},
"cleared": true,
"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
1 - 20 elementsOne step in a chain. The params shape is correlated with the
verb discriminator via OpenAPI 3.1 discriminator.mapping —
each variant carries the exact params shape its verb accepts.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
Show child attributes
Show child attributes
Top-level capture policy for a chain request. Per-step capture
always overrides this default. 'each' captures every step;
'final' captures only the last; 'none' (default) captures
nothing.
each, final, none Was this page helpful?
curl --request POST \
--url https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/chain \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"steps": [
{
"verb": "tap",
"params": {
"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({
steps: [
{verb: 'tap', params: {index: 2, x: 123, y: 123, stealth: true}, capture: true}
]
})
};
fetch('https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/chain', 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}/chain"
payload = { "steps": [
{
"verb": "tap",
"params": {
"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,
"steps": [
{
"ok": true,
"exit_code": 123,
"status": "<string>",
"verb": "tap",
"commandId": "<string>",
"durationMs": 123,
"message": "<string>",
"resolved": {
"x": 123,
"y": 123,
"index": 123
},
"cleared": true,
"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>"
}