Capture a screenshot with options (format, quality, region)

Screenshot as base64-encoded image

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

cURL

curl --request POST \
  --url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screenshot' \
  --header "Authorization: Bearer $STATESET_SANDBOX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "format": "png",
  "quality": 85,
  "region": {
    "x": 1,
    "y": 1,
    "width": 1,
    "height": 1
  }
}'

200

{
  "image": "aGVsbG8=",
  "format": "png"
}

Path parameters

id · string (uuid) · required

Sandbox identifier

Request body

ScreenshotRequest

format · string · required

quality · integer

region · object

Response

object

image · string (byte) · required

Base64-encoded image data

format · string · required

Status codes

Code	Meaning
200	Screenshot as base64-encoded image
400	Invalid request
404	Sandbox not found
500	Screenshot capture failed

cURL

curl --request POST \
  --url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screenshot' \
  --header "Authorization: Bearer $STATESET_SANDBOX_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "format": "png",
  "quality": 85,
  "region": {
    "x": 1,
    "y": 1,
    "width": 1,
    "height": 1
  }
}'

200

{
  "image": "aGVsbG8=",
  "format": "png"
}