Perform a mouse action (click, move, drag, double-click)

Mouse action executed successfully

POST /api/v1/sandbox/{id}/mouse

cURL

curl --request POST \
  --url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/mouse' \
  --header "Authorization: Bearer $STATESET_SANDBOX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "click",
  "x": 1,
  "y": 1,
  "button": 1,
  "endX": 1,
  "endY": 1
}'

200

{
  "success": true
}

Path parameters

id · string (uuid) · required

Sandbox identifier

Request body

MouseActionRequest

action · string · required

x · integer · required

y · integer · required

button · integer

endX · integer

endY · integer

Response

SuccessResponse

success · boolean

Status codes

Code	Meaning
200	Mouse action executed successfully
400	Invalid request
404	Sandbox not found
500	Mouse action failed

cURL

curl --request POST \
  --url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/mouse' \
  --header "Authorization: Bearer $STATESET_SANDBOX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "click",
  "x": 1,
  "y": 1,
  "button": 1,
  "endX": 1,
  "endY": 1
}'

200

{
  "success": true
}