Skip to content

List what Xovris can do in a system

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/systems/profiles/{provider}/actions
curl --request GET \  --url https://api.xovris.ai/v1/systems/profiles/example/actions \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

provider
required
string

Done.

Media typeapplication/json
object
provider
required
string
title
required
string
counts
required
object
reads
required
number
actions
required
number
byClass
required
object
R0
required
number
R1
required
number
R2
required
number
R3
required
number
R4
required
number
undoable
required
number
actions
required
Array<object>
object
id
required
string
title
required
string
verb
required
string
resource
required
string
reversibility
required
string
Allowed values: R0 R1 R2 R3 R4
why
required
string
undo
required
One of:
string
runsOnItsOwn
required
boolean
proved
required
object
ok
required
boolean
refused
required
boolean
detail
required
string
operation
required
string

Example

{  "provider": "string",  "title": "string",  "counts": {    "reads": 1,    "actions": 1,    "byClass": {      "R0": 1,      "R1": 1,      "R2": 1,      "R3": 1,      "R4": 1    },    "undoable": 1  },  "actions": [    {      "id": "string",      "title": "string",      "verb": "string",      "resource": "string",      "reversibility": "R0",      "why": "string",      "undo": "string",      "runsOnItsOwn": true,      "proved": {        "ok": true,        "refused": true,        "detail": "string"      },      "operation": "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.