Desktop Sessions

Create Desktop Session

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

application/json

integration_namestring · min: 1 · max: 256Required

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/{workspace_id}/desktop-sessions

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/desktop-sessions HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "integration_name": "text"
}

{
  "session_id": "text",
  "connected": true,
  "display_size": [
    1
  ]
}

Get Screenshot

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

session_idstring · uuidRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/v1/{workspace_id}/desktop-sessions/{session_id}/screenshot

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/desktop-sessions/{session_id}/screenshot HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Perform Action

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

session_idstring · uuidRequired

Body

application/json

typestring · enumRequiredPossible values:

xany ofOptional

integerOptional

or

nullOptional

yany ofOptional

integerOptional

or

nullOptional

x1any ofOptional

integerOptional

or

nullOptional

y1any ofOptional

integerOptional

or

nullOptional

x2any ofOptional

integerOptional

or

nullOptional

y2any ofOptional

integerOptional

or

nullOptional

textany ofOptional

string · max: 10000Optional

or

nullOptional

keyany ofOptional

string · max: 256Optional

or

nullOptional

buttonany ofOptional

string · max: 32Optional

or

nullOptional

directionany ofOptional

string · enumOptionalPossible values:

or

nullOptional

amountany ofOptional

integer · min: 1 · max: 100Optional

or

nullOptional

Responses

200

Successful Response

application/json

okbooleanRequired

422

Validation Error

application/json

post

/v1/{workspace_id}/desktop-sessions/{session_id}/action

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/desktop-sessions/{session_id}/action HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "type": "click",
  "x": 1,
  "y": 1,
  "x1": 1,
  "y1": 1,
  "x2": 1,
  "y2": 1,
  "text": "text",
  "key": "text",
  "button": "text",
  "direction": "up",
  "amount": 1
}

{
  "ok": true
}

Get Session Status

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

session_idstring · uuidRequired

Responses

200

Successful Response

application/json

session_idstringRequired

connectedbooleanRequired

healthybooleanRequired

created_atnumberRequired

idle_secondsintegerRequired

422

Validation Error

application/json

get

/v1/{workspace_id}/desktop-sessions/{session_id}/status

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/desktop-sessions/{session_id}/status HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "session_id": "text",
  "connected": true,
  "healthy": true,
  "created_at": 1,
  "idle_seconds": 1
}

Disconnect Session

delete

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

session_idstring · uuidRequired

Responses

200

Successful Response

application/json

okbooleanRequired

422

Validation Error

application/json

delete

/v1/{workspace_id}/desktop-sessions/{session_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/desktop-sessions/{session_id} HTTP/1.1
Host: api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true
}