Skip to content

See what Xovris is still carrying on with, and the next step of each

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

A token that can read is enough.

Done.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
kind
required
string
subject
required
string
state
required
string
Allowed values: done in_progress
waitingFor
required
string
Allowed values: provider admin research person retry runner catalogue dns_connection dns_write sender
doing
required
string
manual
required
string
next
required
string
fix
required
One of:
object
label
required
string
method
required
string
Allowed values: GET POST PUT PATCH
path
required
string
body
object
key
additional properties
attempts
required
number
seen
required
number
nextCheckAt
required
One of:
string
lastReason
required
One of:
string
proof
required
One of:
object
key
additional properties
createdAt
required
string
doneAt
required
One of:
string
inProgress
required
number
done
required
number
failed
required
number

Example

{  "items": [    {      "id": "string",      "kind": "string",      "subject": "string",      "state": "done",      "waitingFor": "provider",      "doing": "string",      "manual": "string",      "next": "string",      "fix": {        "label": "string",        "method": "GET",        "path": "string",        "body": {}      },      "attempts": 1,      "seen": 1,      "nextCheckAt": "string",      "lastReason": "string",      "proof": {},      "createdAt": "string",      "doneAt": "string"    }  ],  "inProgress": 1,  "done": 1,  "failed": 1}

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.