curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screenshot' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY"
{
"image": "aGVsbG8=",
"format": "png"
}
Capture a screenshot of the sandbox desktop
Screenshot as base64-encoded image
GET
/
api
/
v1
/
sandbox
/
{id}
/
screenshot
curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screenshot' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY"
{
"image": "aGVsbG8=",
"format": "png"
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Path parameters
string (uuid)
required
Sandbox identifier
Response
object
string (byte)
required
Base64-encoded image data.
string
required
Allowed values:
'png'.Status codes
| Code | Meaning |
|---|---|
200 | Screenshot as base64-encoded image |
404 | Sandbox not found |
500 | Screenshot capture failed |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/screenshot' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY"
{
"image": "aGVsbG8=",
"format": "png"
}
Last modified on September 21, 2026