Capture a full desktop screenshot.
Source:
sandbox-agent/docs/content/docs/api-reference/operations/get_v1_desktop_screenshot.mdxCanonical URL: https://rivet.dev/sandbox-agent/docs/api-reference/operations/get_v1_desktop_screenshot Description: GET /v1/desktop/screenshot: request parameters and responses.
GET /v1/desktop/screenshot
Performs a health-gated full-frame screenshot of the managed desktop and returns the requested image bytes.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
format |
query | No | ||
quality |
query | No | integer | |
scale |
query | No | number | |
showCursor |
query | No | boolean |
Parameter schemas
[
{
"name": "format",
"in": "query",
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/DesktopScreenshotFormat"
}
],
"nullable": true
}
},
{
"name": "quality",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"nullable": true,
"minimum": 0
}
},
{
"name": "scale",
"in": "query",
"required": false,
"schema": {
"type": "number",
"format": "float",
"nullable": true
}
},
{
"name": "showCursor",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"nullable": true
}
}
]Related schemas: DesktopScreenshotFormat.
Responses
200
Desktop screenshot as image bytes
400
Invalid screenshot query
Content type: application/json
{
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}Related schemas: ProblemDetails.
409
Desktop runtime is not ready
Content type: application/json
{
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}Related schemas: ProblemDetails.
502
Desktop runtime health or screenshot capture failed
Content type: application/json
{
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}Related schemas: ProblemDetails.