Skip to content

See everything Xovris is waiting on you for, and how long each has waited

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/autonomy/watches
curl --request GET \  --url https://api.xovris.ai/v1/autonomy/watches \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
door
required
string
runRef
required
string
provider
required
string
kind
required
string
Allowed values: approve sign_in step
state
required
string
Allowed values: done waiting stopped
happened
required
string
Allowed values: refused second_factor with_person captcha not_accepted left_plan stalled has_what_it_needs expired wrong_account wrong_page
line
required
string
next
required
string
pressWhat
required
One of:
string
retry
required
One of:
object
label
required
string
method
required
string
Allowed values: GET POST
path
required
string
body
object
key
additional properties
noticed
required
number
pressed
required
number
openedAt
required
string
changedAt
required
string
expiresAt
required
One of:
string
endedAt
required
One of:
string
proof
required
One of:
string
minutesWaiting
required
number
act
required
One of:
string
Allowed values: payment password security_control
mistakes
required
number
opened
required
number
card
One of:
object
why
required
One of:
string
url
required
One of:
string
urlFrom
required
One of:
string
Allowed values: description answer front_page
opens
required
One of:
string
guide
required
Array<string>
never
required
One of:
string
around
required
One of:
string
takeControl
required
One of:
object
label
required
string
method
required
string
Allowed values: GET POST
path
required
string
body
object
key
additional properties
measure
required
object
ended
required
number
noticed
required
number
pressed
required
number
waitingNow
required
number
percent
required
One of:
number
mistakes
required
number
opened
required
number
line
required
string
empty
required
One of:
string

Example

{  "items": [    {      "id": "string",      "door": "string",      "runRef": "string",      "provider": "string",      "kind": "approve",      "state": "done",      "happened": "refused",      "line": "string",      "next": "string",      "pressWhat": "string",      "retry": {        "label": "string",        "method": "GET",        "path": "string",        "body": {}      },      "noticed": 1,      "pressed": 1,      "openedAt": "string",      "changedAt": "string",      "expiresAt": "string",      "endedAt": "string",      "proof": "string",      "minutesWaiting": 1,      "act": "payment",      "mistakes": 1,      "opened": 1,      "card": {        "why": "string",        "url": "string",        "urlFrom": "description",        "opens": "string",        "guide": [          "string"        ],        "never": "string",        "around": "string",        "takeControl": {          "label": "string",          "method": "GET",          "path": "string",          "body": {}        }      }    }  ],  "measure": {    "ended": 1,    "noticed": 1,    "pressed": 1,    "waitingNow": 1,    "percent": 1,    "mistakes": 1,    "opened": 1,    "line": "string"  },  "empty": "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.