Skip to content

Share a browser tab with Xovris for step-by-step help

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.

POST
/v1/assist/cobrowse
curl --request POST \  --url https://api.xovris.ai/v1/assist/cobrowse \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "guide": null, "requestId": null, "deviceId": null, "goal": null, "minutes": null, "continues": null, "answer": null }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
guide
requestId
deviceId
goal
minutes
continues
answer

Example

{  "guide": null,  "requestId": null,  "deviceId": null,  "goal": null,  "minutes": null,  "continues": null,  "answer": null}

Done: something new was made, and the answer is it.

Media typeapplication/json
One of:
object
id
required
string
guide
required
string
goal
required
string
state
required
string
words
required
string
session
required
object
id
required
string
ran
required
One of:
object
by
required
string
Allowed values: attached
harness
required
string
expires
required
string

Example

{  "id": "string",  "guide": "string",  "goal": "string",  "state": "string",  "words": "string",  "session": {    "id": "string",    "ran": {      "by": "attached",      "harness": "string"    },    "expires": "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.