Skip to content

Download an incident's recording as a file that proves itself - signed where signing is on

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
document
required
object
v
required
number
Allowed values: 1
kind
required
string
Allowed values: xovris.action-record
workspace
required
string
incident
required
string
exportedAt
required
string
record
required
object
incidentId
required
string
runs
required
Array<object>
object
runId
required
string
actionId
required
string
actionVersion
required
number
scope
required
One of:
string
title
required
string
state
required
string
outcome
required
One of:
string
steps
required
number
frames
required
Array<object>
object
seq
required
number
at
required
string
kind
required
string
Allowed values: state read decision proof change
title
required
string
state
object
from
required
string
to
required
string
step
object
id
required
string
phase
required
string
attempts
required
number
read
Array<object>
object
what
required
string
source
required
One of:
string
detail
required
One of:
string
changed
One of:
object
before
required
One of:
object
key
additional properties
after
required
One of:
object
key
additional properties
proved
One of:
object
what
required
string
by
One of:
string
passed
required
One of:
boolean
digest
required
One of:
string
ledgerSeq
required
One of:
number
chainHash
required
One of:
string
undo
One of:
object
state
required
string
Allowed values: taken_back by_hand exact compensate cannot
how
required
One of:
string
bySeq
required
One of:
number
steps
Array<string>
press
One of:
object
seq
required
number
undoes
One of:
number
runId
required
One of:
string
devices
Array<object>
object
checkId
required
string
kind
required
string
title
required
string
machine
required
string
state
required
string
outcome
required
One of:
string
detail
required
One of:
string
at
required
One of:
string
verify
required
string
Allowed values: /v1/actions/verify
signature
required
One of:
object
alg
required
string
Allowed values: Ed25519
keyId
required
string
value
required
string
publicKey
required
One of:
string
signing
required
object
on
required
boolean
said
required
string
verify
required
object
chain
required
string
key
required
string

Example

{  "document": {    "v": 1,    "kind": "xovris.action-record",    "workspace": "string",    "incident": "string",    "exportedAt": "string",    "record": {      "incidentId": "string",      "runs": [        {          "runId": "string",          "actionId": "string",          "actionVersion": 1,          "scope": "string",          "title": "string",          "state": "string",          "outcome": "string",          "steps": 1        }      ],      "frames": [        {          "seq": 1,          "at": "string",          "kind": "state",          "title": "string",          "state": {            "from": "string",            "to": "string"          },          "step": {            "id": "string",            "phase": "string",            "attempts": 1          },          "read": [            {              "what": "string",              "source": "string",              "detail": "string"            }          ],          "changed": {            "before": {},            "after": {}          },          "proved": {            "what": "string",            "by": "string",            "passed": true,            "digest": "string",            "ledgerSeq": 1,            "chainHash": "string"          },          "undo": {            "state": "taken_back",            "how": "string",            "bySeq": 1,            "steps": [              "string"            ],            "press": {              "seq": null            }          },          "undoes": 1,          "runId": "string"        }      ],      "devices": [        {          "checkId": "string",          "kind": "string",          "title": "string",          "machine": "string",          "state": "string",          "outcome": "string",          "detail": "string",          "at": "string"        }      ],      "verify": "/v1/actions/verify"    }  },  "signature": {    "alg": "Ed25519",    "keyId": "string",    "value": "string"  },  "publicKey": "string",  "signing": {    "on": true,    "said": "string"  },  "verify": {    "chain": "string",    "key": "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.