Skip to content

Export the story of each thing you own

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

A token that can read is enough.

Done.

Media typeapplication/json
object
format
required
string
Allowed values: xovris.notarised-pack/1
kind
required
string
subject
required
object
key
additional properties
string
createdAt
required
string
entries
required
Array<object>
object
canonical
required
string
hash
required
string
chain
required
object
algorithm
required
string
Allowed values: sha256
rule
required
string
root
required
string
anchor
required
One of:
object
type
required
string
Allowed values: rfc3161
authority
required
string
token
required
string
genTime
required
One of:
string
hourly
One of:
object
type
required
string
Allowed values: rfc3161-batch
workspace
required
string
from
required
object
seq
required
number
chainHash
required
string
links
required
Array<string>
head
required
object
seq
required
number
chainHash
required
string
leaf
required
string
proof
required
Array<object>
object
side
required
string
Allowed values: left right
hash
required
string
root
required
string
authority
required
string
token
required
string
genTime
required
One of:
string
at
required
string
verify
required
string

Example

{  "format": "xovris.notarised-pack/1",  "kind": "string",  "subject": {},  "createdAt": "string",  "entries": [    {      "canonical": "string",      "hash": "string"    }  ],  "chain": {    "algorithm": "sha256",    "rule": "string",    "root": "string"  },  "anchor": {    "type": "rfc3161",    "authority": "string",    "token": "string",    "genTime": "string"  },  "hourly": {    "type": "rfc3161-batch",    "workspace": "string",    "from": {      "seq": 1,      "chainHash": "string"    },    "links": [      "string"    ],    "head": {      "seq": 1,      "chainHash": "string"    },    "leaf": "string",    "proof": [      {        "side": "left",        "hash": "string"      }    ],    "root": "string",    "authority": "string",    "token": "string",    "genTime": "string",    "at": "string"  },  "verify": "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.