a13nDocs
API referenceDesktop-assistance

View Desktop

POST/api/v1/desktop-assistance/{assistance_id}/view

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Path Parameters

assistance_id*Assistance Id

Query Parameters

renew?Renew
Defaultfalse

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.

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/desktop-assistance/string/view" \  -H "Content-Type: application/json" \  -d '{    "epoch": 0,    "session_id": "string"  }'
{  "assistance": {    "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"  },  "expires_in_seconds": 0,  "mode": "view",  "password": "string",  "websocket_url": "string"}