v48

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

Update settings

Update the action settings for the box

put/boxes/{boxId}/actions/settings

Path parameters

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

Box ID

Request body

scalenumber required

The scale of the action to be performed. Must be greater than 0.1 and less than or equal to 1.

Notes:

  • Scale does not change the box's actual screen resolution.
  • It affects the size of the output screenshot and the coordinates/distances of actions. Coordinates and distances are scaled by this factor. Example: when scale = 1, Click({x:100, y:100}); when scale = 0.5, the equivalent position is Click({x:50, y:50}).

Example request

{
  "scale": 1
}

Response

scalenumber required

The scale of the action to be performed. Must be greater than 0.1 and less than or equal to 1.

Notes:

  • Scale does not change the box's actual screen resolution.
  • It affects the size of the output screenshot and the coordinates/distances of actions. Coordinates and distances are scaled by this factor. Example: when scale = 1, Click({x:100, y:100}); when scale = 0.5, the equivalent position is Click({x:50, y:50}).

Example response

{
  "scale": 1
}