Skip to content

Read the code review preferences that apply to a repository

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

A token that can read is enough.

Done.

Media typeapplication/json
One of:
object
repository
required
null
items
required
Array<object>
object
id
required
string
tenantId
required
string
repo
required
One of:
string
paths
required
One of:
string
rule
required
string
action
required
string
Allowed values: lower silence raise
severity
required
One of:
string
Allowed values: critical minor major trivial info
words
required
string
source
required
object
via
required
string
Allowed values: file app cli mcp reply
ref
required
One of:
string
createdBy
required
string
createdAt
required
string

Example

{  "repository": null,  "items": [    {      "id": "string",      "tenantId": "string",      "repo": "string",      "paths": "string",      "rule": "string",      "action": "lower",      "severity": "critical",      "words": "string",      "source": {        "via": "file",        "ref": "string"      },      "createdBy": "string",      "createdAt": "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.