Sign in

v48

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

Take screenshot

Captures a screenshot of the current box screen

post/boxes/{boxId}/actions/screenshot

Path parameters

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

Box ID

Request body

outputFormat'base64' | 'storageKey'

Type of the URI. default is base64.

presignedExpiresInstring

Presigned url expires in. Only takes effect when outputFormat is storageKey.

Supported time units: ms (milliseconds), s (seconds), m (minutes), h (hours) Example formats: "500ms", "30s", "5m", "1h" Default: 30m

saveToAlbumboolean

Whether to save the screenshot to the device screenshot album

Example request

{
  "outputFormat": "base64",
  "presignedExpiresIn": "30m",
  "scrollCapture": {
    "maxHeight": 4000
  },
  "clip": {
    "x": 100,
    "y": 50,
    "width": 800,
    "height": 600
  }
}

Response

uristring required

URL of the screenshot

presignedUrlstring

Presigned url of the screenshot

Example response

{
  "uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...",
  "presignedUrl": "https://example.com/xxxxx/xxxxx/xxxxx"
}