Skip to content

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.

GET
/v1/assist/requests/{id}/report
curl --request GET \  --url https://api.xovris.ai/v1/assist/requests/example/report \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
id
required
string
words
required
string
category
required
string
ending
required
One of:
object
state
required
string
Allowed values: done
proof
required
object
check
required
string
before
required
One of:
string
after
required
string
at
required
string
answered
boolean
endingWords
required
string
attempts
required
number
gapId
required
One of:
string
sourcesRead
required
Array<string>
approachesTried
required
Array<object>
object
approach
required
One of:
string
passed
required
One of:
boolean
note
required
string
at
required
string
writtenByAi
required
boolean
modelsUsed
required
Array<string>
wroteFromReads
required
One of:
object
ms
required
number
drawnMicroUsd
required
number
sentencesTakenOut
required
number
notUnderstood
required
One of:
object
tries
required
Array<object>
object
reason
required
string
ms
required
number
drawnMicroUsd
required
number
understood
required
One of:
object
ms
required
number
drawnMicroUsd
required
number
chosen
required
One of:
object
model
required
string
name
required
string
answeredBy
required
One of:
string
effort
required
One of:
string
checks
required
Array<object>
object
check
required
One of:
string
passed
required
One of:
boolean
at
required
string
failingCheckNowPassing
required
One of:
object
check
required
string
before
required
One of:
string
after
required
string
at
required
string
answered
boolean
timeAndMoneySaved
required
object
measured
required
boolean
thisSeconds
required
One of:
number
yardstickSeconds
required
One of:
number
against
required
One of:
string
Allowed values: first_time_fixes earlier_same_kind
of
required
number
savedSeconds
required
One of:
number
money
required
One of:
object
amountMinor
required
number
currency
required
string
rate
required
object
what
required
string
source
required
string
url
required
string
read
required
string
amountMinor
required
number
currency
required
string
words
required
string
steps
required
Array<object>
object
rung
required
string
Allowed values: check approach stronger_model second_mind research build_tool browser_door vendor person_step
approach
required
One of:
string
model
required
One of:
string
source
required
One of:
string
check
required
One of:
string
passed
required
One of:
boolean
note
required
string
at
required
string

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.

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.