a13nDocs
API referenceEnvironments

Take Over Desktop

POST/api/v1/environments/{environment_id}/desktop-control/takeover

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

environment_id*Environment Id

Header Parameters

If-Match?|

The resource's ETag: "{id}:{version}" of its current view, "{key}:{version}" for a model

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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/environments/string/desktop-control/takeover" \  -H "Content-Type: application/json" \  -d '{    "thread_id": "string"  }'
{  "control": "automation",  "controller_id": "string",  "controller_thread_id": "string",  "episode": 0,  "expires_at": "2019-08-24T14:15:22Z",  "failure": "string",  "generation": 0,  "id": "string",  "version": 0}