Skip to content

Send the shared tab's outline and get the next step

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/{id}/frame
curl --request POST \  --url https://api.xovris.ai/v1/assist/cobrowse/example/frame \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "url": "string", "title": "string", "elements": [ { "ref": "string", "role": "text", "name": "string", "value": "string", "filled": true, "options": [ "string" ], "checked": true } ], "tab": "string" }'

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

id
required
string
Media typeapplication/json
object
url
required
string
title
required
string
elements
required
Array<object>
object
ref
required
string
role
required
string
Allowed values: text button link password heading textbox combobox checkbox
name
required
string
value
string
filled
boolean
options
Array<string>
checked
boolean
tab
string

Example

{  "url": "string",  "title": "string",  "elements": [    {      "ref": "string",      "role": "text",      "name": "string",      "value": "string",      "filled": true,      "options": [        "string"      ],      "checked": true    }  ],  "tab": "string"}

Done.

Media typeapplication/json
One of:
object
id
required
string
guide
required
string
goal
required
string
state
required
string
Allowed values: stopped sharing finished
pending
required
One of:
object
step
required
object
id
required
string
explain
required
string
point
required
One of:
object
ref
required
string
name
required
string
action
required
One of:
object
kind
required
string
Allowed values: click
ref
required
string
personDoes
required
One of:
string
digest
required
string
frame
required
object
url
required
string
title
required
string
elements
required
Array<object>
object
ref
required
string
role
required
string
Allowed values: text button link password heading textbox combobox checkbox
name
required
string
value
string
filled
boolean
options
Array<string>
checked
boolean
tab
string

Example

{  "id": "string",  "guide": "string",  "goal": "string",  "state": "stopped",  "pending": {    "step": {      "id": "string",      "explain": "string",      "point": {        "ref": "string",        "name": "string"      },      "action": {        "kind": "click",        "ref": "string"      },      "personDoes": "string"    },    "digest": "string",    "frame": {      "url": "string",      "title": "string",      "elements": [        {          "ref": "string",          "role": "text",          "name": "string",          "value": "string",          "filled": true,          "options": [            "string"          ],          "checked": true        }      ],      "tab": "string"    }  }}

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

Media typeapplication/json
object

Example generated

{}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

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.