Skip to content

Read this week's letter, every figure from your own records

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

A token that can read is enough.

Done.

Media typeapplication/json
object
version
required
string
audience
required
string
Allowed values: business family person
workspaceName
required
string
subject
required
string
headline
string
week
required
string
opening
required
string
quiet
required
boolean
sections
required
Array<object>
object
id
required
string
Allowed values: found fixed tuned held reviews money checked prevented efficiency knows
title
required
string
lines
required
Array<string>
next
required
Array<object>
object
text
required
string
url
required
string
figures
required
Array<object>
object
key
required
string
value
required
number
source
required
string
records
Array<string>
trace
object
store
required
string
where
required
string
url
required
string
nextTitle
required
string
linkLabel
required
string
footer
required
string
localeFellBack
required
boolean
unsubscribeLabel
required
string
unsubscribeUrl
string

Example

{  "version": "string",  "audience": "business",  "workspaceName": "string",  "subject": "string",  "headline": "string",  "week": "string",  "opening": "string",  "quiet": true,  "sections": [    {      "id": "found",      "title": "string",      "lines": [        "string"      ]    }  ],  "next": [    {      "text": "string",      "url": "string"    }  ],  "figures": [    {      "key": "string",      "value": 1,      "source": "string",      "records": [        "string"      ],      "trace": {        "store": "string",        "where": "string"      }    }  ],  "url": "string",  "nextTitle": "string",  "linkLabel": "string",  "footer": "string",  "localeFellBack": true,  "unsubscribeLabel": "string",  "unsubscribeUrl": "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.