Skip to content

Watch one computer session as it goes - the latest screen, the window in front, every step with the reason it was taken

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

GET
/v1/computer/sessions/{id}
curl --request GET \  --url https://api.xovris.ai/v1/computer/sessions/example \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
session
required
object
frame
required
One of:
string
working
required
boolean
replayAt
required
string
id
required
string
goal
required
string
schedule
string
skill
string
held
boolean
teach
boolean
on
required
One of:
object
kind
required
string
Allowed values: cloud
state
required
string
Allowed values: done ended working asking taken_back waiting_for_approval handed_back
steps
required
Array<object>
object
step
required
object
session
required
string
seq
required
number
do
required
string
Allowed values: type key done open move click wait double_click ask triple_click middle_click right_click scroll back drag hold_key switch_tab new_tab close_tab shell zoom
target
object
window
required
string
program
string
x
number
y
number
toX
number
toY
number
text
string
keys
Array<string>
url
string
dy
number
ms
number
why
required
string
control
object
role
required
string
name
required
string
evidence
string
commits
string
outcome
required
string
Allowed values: done refused not_run missed
words
required
string
at
required
string
taught
boolean
front
required
One of:
object
window
required
string
program
required
string
url
string
by
required
string
startedAt
required
string
expires
required
string
endedAt
string
handBack
string
signed
object
task
required
signature
required
string
desk
string
takenBy
string
Allowed values: viewer stop esc
notes
Array<string>
replay
boolean
replayRemoved
object
at
required
string
frames
required
number
replayGaps
Array<number>
said
Array<object>
object
words
required
string
at
required
string
replies
Array<object>
object
words
required
string
at
required
string
engineAt
string
request
string
ran
One of:
object
by
required
string
Allowed values: attached
harness
required
string
tab
object
seq
required
number
said
required
string
group
Array<object>
object
key
required
string
title
required
string
url
required
string
at
required
string
confirm
object
seq
required
number
commits
required
string
at
required
string
answer
string
Allowed values: yes no
step
object
x
number
keys
Array<string>
text
string
target
object
window
required
string
program
string
url
string
why
required
string
evidence
string
ms
number
y
number
control
object
role
required
string
name
required
string
do
required
string
Allowed values: type key done open move click wait double_click ask triple_click middle_click right_click scroll back drag hold_key switch_tab new_tab close_tab shell zoom
toX
number
toY
number
commits
string
dy
number
planted
Array<object>
object
where
required
string
rule
required
string
excerpt
required
string
at
required
string

Example

{  "session": {    "frame": "string",    "working": true,    "replayAt": "string",    "id": "string",    "goal": "string",    "schedule": "string",    "skill": "string",    "held": true,    "teach": true,    "on": {      "kind": "cloud"    },    "state": "done",    "steps": [      {        "step": {          "session": "string",          "seq": 1,          "do": "type",          "target": {            "window": "string",            "program": "string"          },          "x": 1,          "y": 1,          "toX": 1,          "toY": 1,          "text": "string",          "keys": [            "string"          ],          "url": "string",          "dy": 1,          "ms": 1,          "why": "string",          "control": {            "role": "string",            "name": "string"          },          "evidence": "string",          "commits": "string"        },        "outcome": "done",        "words": "string",        "at": "string",        "taught": true      }    ],    "front": {      "window": "string",      "program": "string",      "url": "string"    },    "by": "string",    "startedAt": "string",    "expires": "string",    "endedAt": "string",    "handBack": "string",    "signed": {      "task": null,      "signature": "string"    },    "desk": "string",    "takenBy": "viewer",    "notes": [      "string"    ],    "replay": true,    "replayRemoved": {      "at": "string",      "frames": 1    },    "replayGaps": [      1    ],    "said": [      {        "words": "string",        "at": "string"      }    ],    "replies": [      {        "words": "string",        "at": "string"      }    ],    "engineAt": "string",    "request": "string",    "ran": {      "by": "attached",      "harness": "string"    },    "tab": {      "seq": 1,      "said": "string"    },    "group": [      {        "key": "string",        "title": "string",        "url": "string",        "at": "string"      }    ],    "confirm": {      "seq": 1,      "commits": "string",      "at": "string",      "answer": "yes",      "step": {        "x": 1,        "keys": [          "string"        ],        "text": "string",        "target": {          "window": "string",          "program": "string"        },        "url": "string",        "why": "string",        "evidence": "string",        "ms": 1,        "y": 1,        "control": {          "role": "string",          "name": "string"        },        "do": "type",        "toX": 1,        "toY": 1,        "commits": "string",        "dy": 1      }    },    "planted": [      {        "where": "string",        "rule": "string",        "excerpt": "string",        "at": "string"      }    ]  }}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.