Skip to content

Download a job's signed recording

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

A token that can read is enough.

job
required
string

Done.

Media typeapplication/json
One of:
object
document
required
object
v
required
number
Allowed values: 1
kind
required
string
Allowed values: xovris.job-record
workspace
required
string
job
required
string
exportedAt
required
string
record
required
object
job
required
string
version
required
string
mode
required
string
at
required
string
status
required
string
outcome
required
One of:
string
settledAt
required
One of:
string
changes
required
Array
signature
required
null
publicKey
required
null
signing
required
object
on
required
boolean
said
required
string
verify
required
object
key
required
string
check
required
string

Example

{  "document": {    "v": 1,    "kind": "xovris.job-record",    "workspace": "string",    "job": "string",    "exportedAt": "string",    "record": {      "job": "string",      "version": "string",      "mode": "string",      "at": "string",      "status": "string",      "outcome": "string",      "settledAt": "string",      "changes": [        null      ]    }  },  "signature": null,  "publicKey": null,  "signing": {    "on": true,    "said": "string"  },  "verify": {    "key": "string",    "check": "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.