Skip to content

Read each set-up method's verified record before it runs

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/public/recipes/records
curl --request GET \  --url https://api.xovris.ai/v1/public/recipes/records

No token needed: anyone may call this.

Done.

Media typeapplication/json
object
records
required
Array<object>
object
recipeId
required
string
finished
required
number
verified
required
number
rolledBack
required
number
handedToPerson
required
number
successRate
required
One of:
number
lowerBound
required
One of:
number
workspaces
required
number
regions
required
Array<string>
lastVerifiedAt
required
One of:
string
threshold
required
object
minRuns
required
number
lowerBound
required
number
standing
required
string
Allowed values: proven below new
route
required
string
Allowed values: research recipe
words
required
string
hold
required
One of:
object
kind
required
string
Allowed values: source_changed nightly_failed
since
required
string
sourceUrl
required
One of:
string
thresholds
required
object
key
additional properties
object
minRuns
required
number
lowerBound
required
number
measuredAt
required
string

Example

{  "records": [    {      "recipeId": "string",      "finished": 1,      "verified": 1,      "rolledBack": 1,      "handedToPerson": 1,      "successRate": 1,      "lowerBound": 1,      "workspaces": 1,      "regions": [        "string"      ],      "lastVerifiedAt": "string",      "threshold": {        "minRuns": 1,        "lowerBound": 1      },      "standing": "proven",      "route": "research",      "words": "string",      "hold": {        "kind": "source_changed",        "since": "string",        "sourceUrl": "string"      }    }  ],  "thresholds": {},  "measuredAt": "string"}

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.