Skip to content

Read a thing Xovris has met

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/things/{id}
curl --request GET \  --url https://api.xovris.ai/v1/things/example \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
id
required
string
host
required
string
is
required
One of:
object
maker
required
string
model
required
string
what
required
string
reach
required
string
Allowed values: proved network visitor
readings
required
object
key
additional properties
One of:
string
normal
required
object
key
additional properties
One of:
string
bands
required
object
key
additional properties
object
min
number
max
number
seen
required
number
since
required
string
last
number
tracked
number
rose
number
states
object
key
additional properties
number
free
boolean
departures
required
Array<object>
object
reading
required
string
normal
required
One of:
string
now
required
One of:
string
band
object
min
required
number
max
required
number
reads
required
number
tests
required
number
complete
required
boolean
changes
required
Array<object>
object
source
required
string
to
One of:
string
action
required
string
sets
required
string
lastChange
required
One of:
object
digest
required
string
action
required
string
undo
required
string
reading
required
string
before
required
One of:
string
to
required
One of:
string
by
required
string
at
required
string
undoneAt
string
why
required
Array<string>
metAt
required
string
watchedAt
required
One of:
string

Example

{  "id": "string",  "host": "string",  "is": {    "maker": "string",    "model": "string",    "what": "string"  },  "reach": "proved",  "readings": {},  "normal": {},  "bands": {},  "departures": [    {      "reading": "string",      "normal": "string",      "now": "string",      "band": {        "min": 1,        "max": 1      }    }  ],  "reads": 1,  "tests": 1,  "complete": true,  "changes": [    {      "source": "string",      "to": "string",      "action": "string",      "sets": "string"    }  ],  "lastChange": {    "digest": "string",    "action": "string",    "undo": "string",    "reading": "string",    "before": "string",    "to": "string",    "by": "string",    "at": "string",    "undoneAt": "string"  },  "why": [    "string"  ],  "metAt": "string",  "watchedAt": "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.