Skip to content

Replay a computer session you ran, step by step, each step beside the screen it was chosen from

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}/replay
curl --request GET \  --url https://api.xovris.ai/v1/computer/sessions/example/replay \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
session
required
string
goal
required
string
state
required
string
Allowed values: done ended working asking taken_back waiting_for_approval handed_back
handBack
required
One of:
string
ran
required
One of:
object
by
required
string
Allowed values: attached
harness
required
string
steps
required
Array<object>
object
frame
required
One of:
string
seq
required
number
do
required
string
why
required
string
outcome
required
string
Allowed values: done refused not_run missed
words
required
string
at
required
string
window
required
One of:
string
page
object
console
required
Array<object>
object
level
required
string
text
required
string
network
required
Array<object>
object
method
required
string
url
required
string
status
required
One of:
number
failed
string
requests
Array<object>
object
method
required
string
url
required
string
status
required
One of:
number
failed
string
tab
string
zoom
object
x
required
number
y
required
number
toX
required
number
toY
required
number
kept
required
number
reel
required
Array<object>
object
at
required
string
seq
required
number
src
required
string
words
required
string

Example

{  "session": "string",  "goal": "string",  "state": "done",  "handBack": "string",  "ran": {    "by": "attached",    "harness": "string"  },  "steps": [    {      "frame": "string",      "seq": 1,      "do": "string",      "why": "string",      "outcome": "done",      "words": "string",      "at": "string",      "window": "string",      "page": {        "console": [          {            "level": "string",            "text": "string"          }        ],        "network": [          {            "method": "string",            "url": "string",            "status": 1,            "failed": "string"          }        ]      },      "requests": [        {          "method": "string",          "url": "string",          "status": 1,          "failed": "string",          "tab": "string"        }      ],      "zoom": {        "x": 1,        "y": 1,        "toX": 1,        "toY": 1      }    }  ],  "kept": 1,  "reel": [    {      "at": "string",      "seq": 1,      "src": "string"    }  ],  "words": "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.