Launch an app

POST

workspaces

{workspaceId}

devices

{deviceId}

apps

start

Launch an app

curl --request POST \
  --url https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/apps/start \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "package": "<string>",
  "activity": "<string>",
  "capture": true
}
'

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({package: '<string>', activity: '<string>', capture: true})
};

fetch('https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/apps/start', 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}/apps/start"

payload = {
    "package": "<string>",
    "activity": "<string>",
    "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>",
  "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

X-Api-Key

string

header

required

Workspace API key, created in the dashboard under Settings → API Keys.

Path Parameters

workspaceId

string<uuid>

required

Workspace UUID. Caller must have access.

deviceId

string

required

Device id (paired into the workspace).

Body

application/json

package

string

required

Dotted Java identifier, first segment letter-led. Case-insensitive (the runtime regex carries the i flag). A value such as com.x; reboot is rejected with a 400.

Required string length: 1 - 255

Pattern: ^[A-Za-z][A-Za-z0-9_]*(\.[A-Za-z][A-Za-z0-9_]*)+$

activity

string

Relative-or-fully-qualified Android activity name; a leading . (.MainActivity) is accepted. Validated against the same regex before dispatch.

Required string length: 1 - 255

Pattern: ^\.?[A-Za-z0-9_]+(\.[A-Za-z0-9_]+)*$

capture

capture: boolean | CaptureOptions. true captures with defaults; an object lets the caller override individual knobs. false or omitted = no capture.

Response

App launch dispatched (capture optional)

boolean

required

exit_code

integer

required

0 on success, non-zero on failure. Currently derived from ok; it does not carry the command's own exit code.

status

string

required

commandId

string

durationMs

integer | null

message

string

capture

object

Capture payload. All inner fields are optional and present iff the corresponding source was captured:

elements / element_count / screen_dimensions — set iff capture.ui was true.
screenshot_url — set iff capture.screenshot was 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

Launch an app

curl --request POST \
  --url https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/apps/start \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "package": "<string>",
  "activity": "<string>",
  "capture": true
}
'

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({package: '<string>', activity: '<string>', capture: true})
};

fetch('https://api.lusor.ai/v1/workspaces/{workspaceId}/devices/{deviceId}/apps/start', 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}/apps/start"

payload = {
    "package": "<string>",
    "activity": "<string>",
    "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>",
  "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>"
}

Overview

Endpoints

Launch an app

Authorizations

Path Parameters

Body

Response