Skip to content

Virtual desktops ​

Desktop sessions bots use to work. 5 endpoints

GET /desktop-sessions​

/api/v1/desktop-sessions · Needs a session

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/desktop-sessions' \
  -H "Authorization: Bearer $LEX_TOKEN"

GET /bots/{botId}/desktop-sessions​

/api/v1/bots/{botId}/desktop-sessions · Needs a session

Parameters

FieldTypeRequiredNotes
botId (path)stringyes

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/bots/:botId/desktop-sessions' \
  -H "Authorization: Bearer $LEX_TOKEN"

POST /bots/{botId}/desktop-sessions​

/api/v1/bots/{botId}/desktop-sessions · Needs a session

Parameters

FieldTypeRequiredNotes
botId (path)stringyes

Request body

FieldTypeRequiredNotes
taskstringlength 0–2000

Example

bash
curl -X POST 'https://api.lexcetha.com/api/v1/bots/:botId/desktop-sessions' \
  -H "Authorization: Bearer $LEX_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{}'

GET /desktop-sessions/{sessionId}​

/api/v1/desktop-sessions/{sessionId} · Needs a session

Parameters

FieldTypeRequiredNotes
sessionId (path)stringyes

Example

bash
curl -X GET 'https://api.lexcetha.com/api/v1/desktop-sessions/:sessionId' \
  -H "Authorization: Bearer $LEX_TOKEN"

POST /desktop-sessions/{sessionId}/stop​

/api/v1/desktop-sessions/{sessionId}/stop · Needs a session

Parameters

FieldTypeRequiredNotes
sessionId (path)stringyes

Example

bash
curl -X POST 'https://api.lexcetha.com/api/v1/desktop-sessions/:sessionId/stop' \
  -H "Authorization: Bearer $LEX_TOKEN"

Lex by Gavalytics AI