API referenceDesktop-assistance

Get Control

GET/api/v1/runs/{run_id}/desktop-control

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

run_id*Run Id

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/runs/string/desktop-control"
{  "cause": "agent",  "controller_id": "string",  "deadline": "2019-08-24T14:15:22Z",  "environment_id": "string",  "epoch": 0,  "failure": "string",  "id": "string",  "lease_expires_at": "2019-08-24T14:15:22Z",  "mount": "string",  "outcome": {},  "reason": "string",  "run_id": "string",  "state": "string",  "tool_call_id": "string"}