Skip to content

Ask about a change and get an answer from the change, its code and what is failing now, each line cited

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/reviews/ask
curl --request POST \  --url https://api.xovris.ai/v1/reviews/ask \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "question": "string", "diff": "string", "files": [ null ] }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
question
string
diff
string
files
Array

Example

{  "question": "string",  "diff": "string",  "files": [    null  ]}

Done.

Media typeapplication/json
object
read
required
object
files
required
number
live
required
string
answer
required
string
cites
required
Array<object>
object
file
required
string
line
required
number
text
required
string
source
required
string
Allowed values: code production diff
grounded
required
boolean
notice
required
string
untrusted
required
boolean

Example

{  "read": {    "files": 1,    "live": "string"  },  "answer": "string",  "cites": [    {      "file": "string",      "line": 1,      "text": "string",      "source": "code"    }  ],  "grounded": true,  "notice": "string",  "untrusted": true}

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.