Sign in

v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB
UI Action

Click

Simulates a click action on the box.

post/boxes/{boxId}/actions/click

Path parameters

boxIdstring required
Example:c9bdc193-b54b-4ddb-a035-5ac0c598d32d

Box ID

Request body

OR
OR

Example request

{
  "button": "left",
  "modifierKeys": [
    "control",
    "shift"
  ],
  "x": 350,
  "y": 250,
  "options": {
    "screenshot": {
      "outputFormat": "base64",
      "presignedExpiresIn": "30m",
      "delay": "500ms",
      "phases": [
        "before",
        "after"
      ]
    }
  },
  "outputFormat": "base64",
  "presignedExpiresIn": "30m",
  "screenshotDelay": "500ms"
}

Response

Click action executed successfully. The response includes the actual coordinates where the click was performed, which is especially useful when using natural language targeting.

messagestring required

message

actionIdstring required

Unique identifier for each action. Use this ID to locate the action and report issues.

Example response

{
  "message": "Action executed successfully",
  "actionId": "c9bdc193-b54b-4ddb-a035-5ac0c598d32d",
  "screenshot": {
    "trace": {
      "uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
    },
    "before": {
      "uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...",
      "presignedUrl": "https://example.com/xxxxx/xxxxx/xxxxx"
    },
    "after": {
      "uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...",
      "presignedUrl": "https://example.com/xxxxx/xxxxx/xxxxx"
    }
  },
  "actual": {
    "x": 350,
    "y": 250,
    "button": "left",
    "modifierKeys": [
      "control"
    ]
  }
}