Sign in

v48

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

Scroll

Performs a scroll action. Supports both advanced scroll with coordinates and simple scroll with direction.

post/boxes/{boxId}/actions/scroll

Path parameters

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

Box ID

Request body

OR

Example request

{
  "scrollY": -100,
  "x": 400,
  "y": 300,
  "options": {
    "screenshot": {
      "outputFormat": "base64",
      "presignedExpiresIn": "30m",
      "delay": "500ms",
      "phases": [
        "before",
        "after"
      ]
    }
  },
  "outputFormat": "base64",
  "presignedExpiresIn": "30m",
  "screenshotDelay": "500ms"
}

Response

Scroll action result with actual parameters used

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": 400,
    "y": 300,
    "scrollY": -100
  }
}