Start a set-up
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.
const url = 'https://api.xovris.ai/v1/setup/runs';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"recipe":"string","version":1,"input":{},"budgetMicroUsd":{},"credentials":{}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.xovris.ai/v1/setup/runs \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "recipe": "string", "version": 1, "input": {}, "budgetMicroUsd": {}, "credentials": {} }'Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.
Authorizations
Section titled “Authorizations”Request Body
Section titled “Request Body”object
object
object
object
Example
{ "recipe": "string", "version": 1, "input": {}, "budgetMicroUsd": {}, "credentials": {}}Responses
Section titled “Responses”Done.
object
object
object
object
object
object
object
object
Example
{ "record": { "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" } }, "name": "string", "message": "string", "stack": "string", "cause": null}Done: something new was made, and the answer is it.
object
object
object
object
object
Example
{ "fromFacts": [ "string" ], "site": { "id": "string", "label": "string", "words": "string" }, "keysKept": [ "string" ], "ok": true, "record": { "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" } }, "run": { "provider": "string", "steps": [ { "id": "string", "title": "string", "class": "string", "state": "string", "before": null, "decisionId": "string", "attempts": 1, "at": "string", "adoptedFrom": "string", "foundInPlace": true } ], "state": "string", "runId": "string", "startedAt": "string", "next": "string", "title": "string", "awaiting": { "kind": "approve", "stepId": "string" }, "outcome": { "title": "string", "verdict": "not_checked", "signal": "string", "evidence": null, "at": "string" }, "recipe": "string", "note": "string", "finishedAt": "string", "signIn": { "stepId": "string", "domain": "string", "url": "string" }, "continues": "string", "diagnosis": { "class": "paused", "stepId": "string", "words": "string", "xovrisNext": "string", "personNext": "string", "recovering": true, "answer": "string", "personClears": true, "methodFailed": true }, "budgetMicroUsd": 1, "inPlace": [ "string" ], "continuedBy": "string", "drawnMicroUsd": 1 }}Started: the answer says where to follow it.
object
Example generated
{}Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.