Read the report of one request: what was read, tried and proved
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/assist/requests/example/report';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/assist/requests/example/report \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”Done.
object
object
Example
{ "id": "string", "words": "string", "category": "string", "ending": { "state": "done", "proof": { "check": "string", "before": "string", "after": "string", "at": "string", "answered": true } }, "endingWords": "string", "attempts": 1, "gapId": "string", "sourcesRead": [ "string" ], "approachesTried": [ { "approach": "string", "passed": true, "note": "string", "at": "string" } ], "writtenByAi": true, "modelsUsed": [ "string" ], "wroteFromReads": { "ms": 1, "drawnMicroUsd": 1, "sentencesTakenOut": 1 }, "notUnderstood": { "tries": [ { "reason": "string" } ], "ms": 1, "drawnMicroUsd": 1 }, "understood": { "ms": 1, "drawnMicroUsd": 1 }, "chosen": { "model": "string", "name": "string", "answeredBy": "string" }, "effort": "string", "checks": [ { "check": "string", "passed": true, "at": "string" } ], "failingCheckNowPassing": { "check": "string", "before": "string", "after": "string", "at": "string", "answered": true }, "timeAndMoneySaved": { "measured": true, "thisSeconds": 1, "yardstickSeconds": 1, "against": "first_time_fixes", "of": 1, "savedSeconds": 1, "money": { "amountMinor": 1, "currency": "string", "rate": { "what": "string", "source": "string", "url": "string", "read": "string", "amountMinor": 1, "currency": "string" } }, "words": "string" }, "steps": [ { "rung": "check", "approach": "string", "model": "string", "source": "string", "check": "string", "passed": true, "note": "string", "at": "string" } ]}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.