Sign in
Agent environments

Issue a short-lived desktop stream ticket for the environment machine

post/api/v1/agent-environments/{environmentId}/desktop

Path parameters

environmentIdstring required

Request body

mode'vnc' | 'webrtc'

Response

Successful response. Stable response schemas are documented in workflow guides when available.

{"stackTrail":"paths:/api/v1/agent-environments/{environmentId}/desktop:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","description":"Response shape is route-specific and may be backed by @overlay/app-core contracts."}

Changes

Changed in 1 of the 32 revisions of this API.1