Skip to content

Explain an error for free

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/public/explain
curl --request POST \  --url https://api.xovris.ai/v1/public/explain \  --header 'Content-Type: application/json' \  --data '{ "ok": true, "res": { "headers": {}, "ok": true, "redirected": true, "status": 1, "statusText": "string", "type": "basic", "url": "string", "body": { "locked": true }, "bodyUsed": true }, "text": "string" }'

Open to anyone, so no Idempotency-Key is kept: nobody is signed in to keep it for, and replaying one caller’s answer to another would hand it over.

No token needed: anyone may call this.

Media typeapplication/json
object
ok
boolean
res
object
headers
required
object
ok
required
boolean
redirected
required
boolean
status
required
number
statusText
required
string
type
required
string
Allowed values: basic error default cors opaque opaqueredirect
url
required
string
body
required
One of:
object
locked
required
boolean
bodyUsed
required
boolean
text
string

Example

{  "ok": true,  "res": {    "headers": {},    "ok": true,    "redirected": true,    "status": 1,    "statusText": "string",    "type": "basic",    "url": "string",    "body": {      "locked": true    },    "bodyUsed": true  },  "text": "string"}

Done.

Media typeapplication/json
object
beforeSignUp
required
number
stored
required
boolean

Example

{  "beforeSignUp": 1,  "stored": true}

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.