Skip to content

Read how much a person had to do to get set up

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

A token that can read is enough.

Done.

Media typeapplication/json
object
bar
required
object
minRuns
required
number
Allowed values: 14
completionLower95
required
number
Allowed values: 0.78
maxAvoidableAtMedian
required
number
Allowed values: 1
usefulP90Seconds
required
number
Allowed values: 600
runs
required
number
journeys
required
Array<object>
object
journey
required
string
counted
required
number
notCounted
required
object
unknown
number
lab
number
nontechnical
number
technical
number
simulated
number
completion
required
object
k
required
number
n
required
number
rate
required
One of:
number
lower95
required
One of:
number
upper95
required
One of:
number
activeSeconds
required
object
n
required
number
median
required
One of:
number
p90
required
One of:
number
inputs
required
object
n
required
number
median
required
One of:
number
p90
required
One of:
number
unavoidable
required
One of:
number
avoidableMedian
required
One of:
number
timeToUsefulSeconds
required
object
n
required
number
median
required
One of:
number
p90
required
One of:
number
verdict
required
string
Allowed values: not_accepted UNMEASURED accepted
why
required
Array<string>
basis
required
string

Example

{  "bar": {    "minRuns": 14,    "completionLower95": 0.78,    "maxAvoidableAtMedian": 1,    "usefulP90Seconds": 600  },  "runs": 1,  "journeys": [    {      "journey": "string",      "counted": 1,      "notCounted": {        "unknown": 1,        "lab": 1,        "nontechnical": 1,        "technical": 1,        "simulated": 1      },      "completion": {        "k": 1,        "n": 1,        "rate": 1,        "lower95": 1,        "upper95": 1      },      "activeSeconds": {        "n": 1,        "median": 1,        "p90": 1      },      "inputs": {        "n": 1,        "median": 1,        "p90": 1      },      "unavoidable": 1,      "avoidableMedian": 1,      "timeToUsefulSeconds": {        "n": 1,        "median": 1,        "p90": 1      },      "verdict": "not_accepted",      "why": [        "string"      ]    }  ],  "basis": "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.