Skip to content

The XOS schema every verdict, proof and confidence is written in

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/public/schemas/xos-v1.json
curl --request GET \  --url https://api.xovris.ai/v1/public/schemas/xos-v1.json

No token needed: anyone may call this.

Done.

Media typeapplication/json

A JSON Schema document: it also carries $schema and $id.

object
title
required
string
type
required
string
Allowed values: object
required
required
Array
properties
required
object
xos
required
object
const
required
number
Allowed values: 1
kind
required
object
enum
required
Array
received_at
required
object
type
required
string
Allowed values: string
format
required
string
Allowed values: date-time
verdict
required
object
type
required
string
Allowed values: object
required
required
Array
properties
required
object
state
required
object
enum
required
Array<string>
Allowed values: unknown fixed stale broken healthy working needs_you at_risk
text
required
object
type
required
string
Allowed values: string
targets
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: object
required
required
Array
properties
required
object
type
required
object
type
required
string
Allowed values: string
id
required
object
type
required
string
Allowed values: string
claims
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: object
required
required
Array
properties
required
object
id
required
object
type
required
string
Allowed values: string
text
required
object
type
required
string
Allowed values: string
support
required
object
enum
required
Array
evidence
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: string
evidence
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: object
required
required
Array
properties
required
object
id
required
object
type
required
string
Allowed values: string
kind
required
object
enum
required
Array
source
required
object
type
required
string
Allowed values: string
captured_at
required
object
type
required
string
Allowed values: string
format
required
string
Allowed values: date-time
ttl_s
required
object
type
required
string
Allowed values: integer
minimum
required
number
Allowed values: 0
rerun
required
object
type
required
string
Allowed values: string
sha256
required
object
type
required
string
Allowed values: string
excerpt
required
object
type
required
string
Allowed values: string
confidence
required
object
type
required
string
Allowed values: object
required
required
Array
properties
required
object
tier
required
object
enum
required
Array
reasons
required
object
minItems
required
number
Allowed values: 1
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: string
would_raise
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: string
record
required
object
oneOf
required
Array
One of:
object
type
required
string
Allowed values: null
alternatives
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: object
required
required
Array
properties
required
object
cause
required
object
type
required
string
Allowed values: string
status
required
object
enum
required
Array
evidence
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: string
plan
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: object
required
required
Array
properties
required
object
step
required
object
type
required
string
Allowed values: string
status
required
object
enum
required
Array
actions
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: object
required
required
Array
properties
required
object
id
required
object
type
required
string
Allowed values: string
label
required
object
type
required
string
Allowed values: string
consequence
required
object
type
required
string
Allowed values: string
explains
required
object
type
required
string
Allowed values: object
required
required
Array<string>
Allowed values: changes
properties
required
object
changes
required
object
type
required
string
Allowed values: string
where
required
object
type
required
string
Allowed values: string
undo
required
object
type
required
string
Allowed values: string
reach
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: string
reversible
required
object
enum
required
Array
undo
required
object
oneOf
required
Array
One of:
object
type
required
string
Allowed values: null
cost
required
object
type
required
string
Allowed values: string
permission
required
object
enum
required
Array
primary
required
object
type
required
string
Allowed values: boolean
proof
required
object
oneOf
required
Array
One of:
object
type
required
string
Allowed values: null
verification
required
object
oneOf
required
Array
One of:
object
type
required
string
Allowed values: null
undo_receipt
required
object
oneOf
required
Array
One of:
object
type
required
string
Allowed values: null
timeline
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: object
required
required
Array
properties
required
object
t
required
object
type
required
string
Allowed values: string
format
required
string
Allowed values: date-time
type
required
object
enum
required
Array
text
required
object
type
required
string
Allowed values: string
body
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: object
required
required
Array
properties
required
object
id
required
object
enum
required
Array
text
required
object
type
required
string
Allowed values: string
changes
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: object
required
required
Array
properties
required
object
group
required
object
type
required
string
Allowed values: string
explanation
required
object
type
required
string
Allowed values: string
target
required
object
type
required
string
Allowed values: string
rows
required
object
type
required
string
Allowed values: array
items
required
object
type
required
string
Allowed values: object
properties
required
object
before
required
object
type
required
Array
after
required
object
type
required
Array
moved
required
object
type
required
string
Allowed values: boolean
impact
required
object
type
required
string
Allowed values: string
agent
required
object
const
required
string
Allowed values: Xovris

Example

{  "title": "string",  "type": "object",  "required": [    "xos"  ],  "properties": {    "xos": {      "const": 1    },    "kind": {      "enum": [        "answer"      ]    },    "received_at": {      "type": "string",      "format": "date-time"    },    "verdict": {      "type": "object",      "required": [        "state"      ],      "properties": {        "state": {          "enum": [            "unknown"          ]        },        "text": {          "type": "string"        }      }    },    "targets": {      "type": "array",      "items": {        "type": "object",        "required": [          "type"        ],        "properties": {          "type": {            "type": "string"          },          "id": {            "type": "string"          }        }      }    },    "claims": {      "type": "array",      "items": {        "type": "object",        "required": [          "id"        ],        "properties": {          "id": {            "type": "string"          },          "text": {            "type": "string"          },          "support": {            "enum": [              "verified"            ]          },          "evidence": {            "type": "array",            "items": {              "type": "string"            }          }        }      }    },    "evidence": {      "type": "array",      "items": {        "type": "object",        "required": [          "id"        ],        "properties": {          "id": {            "type": "string"          },          "kind": {            "enum": [              "measurement"            ]          },          "source": {            "type": "string"          },          "captured_at": {            "type": "string",            "format": "date-time"          },          "ttl_s": {            "type": "integer",            "minimum": 0          },          "rerun": {            "type": "string"          },          "sha256": {            "type": "string"          },          "excerpt": {            "type": "string"          }        }      }    },    "confidence": {      "type": "object",      "required": [        "tier"      ],      "properties": {        "tier": {          "enum": [            "high"          ]        },        "reasons": {          "minItems": 1,          "type": "array",          "items": {            "type": "string"          }        },        "would_raise": {          "type": "array",          "items": {            "type": "string"          }        },        "record": {          "oneOf": [            {              "type": "null"            }          ]        },        "alternatives": {          "type": "array",          "items": {            "type": "object",            "required": [              "cause"            ],            "properties": {              "cause": {                "type": "string"              },              "status": {                "enum": [                  null                ]              },              "evidence": {                "type": "array",                "items": {                  "type": null                }              }            }          }        }      }    },    "plan": {      "type": "array",      "items": {        "type": "object",        "required": [          "step"        ],        "properties": {          "step": {            "type": "string"          },          "status": {            "enum": [              "pending"            ]          }        }      }    },    "actions": {      "type": "array",      "items": {        "type": "object",        "required": [          "id"        ],        "properties": {          "id": {            "type": "string"          },          "label": {            "type": "string"          },          "consequence": {            "type": "string"          },          "explains": {            "type": "object",            "required": [              "changes"            ],            "properties": {              "changes": {                "type": "string"              },              "where": {                "type": "string"              },              "undo": {                "type": "string"              }            }          },          "reach": {            "type": "array",            "items": {              "type": "string"            }          },          "reversible": {            "enum": [              "yes"            ]          },          "undo": {            "oneOf": [              {                "type": null              }            ]          },          "cost": {            "type": "string"          },          "permission": {            "enum": [              "ask"            ]          },          "primary": {            "type": "boolean"          }        }      }    },    "proof": {      "oneOf": [        {          "type": "null"        }      ]    },    "verification": {      "oneOf": [        {          "type": "null"        }      ]    },    "undo_receipt": {      "oneOf": [        {          "type": "null"        }      ]    },    "timeline": {      "type": "array",      "items": {        "type": "object",        "required": [          "t"        ],        "properties": {          "t": {            "type": "string",            "format": "date-time"          },          "type": {            "enum": [              "thought"            ]          },          "text": {            "type": "string"          }        }      }    },    "body": {      "type": "array",      "items": {        "type": "object",        "required": [          "id"        ],        "properties": {          "id": {            "enum": [              "found"            ]          },          "text": {            "type": "string"          }        }      }    },    "changes": {      "type": "array",      "items": {        "type": "object",        "required": [          "group"        ],        "properties": {          "group": {            "type": "string"          },          "explanation": {            "type": "string"          },          "target": {            "type": "string"          },          "rows": {            "type": "array",            "items": {              "type": "object",              "properties": {                "before": {                  "type": null                },                "after": {                  "type": null                },                "moved": {                  "type": null                }              }            }          }        }      }    },    "impact": {      "type": "string"    },    "agent": {      "const": "Xovris"    }  }}

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.