Skip to content

Reply to Xovris about a request

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.

POST
/v1/assist/requests/{id}/reply
curl --request POST \  --url https://api.xovris.ai/v1/assist/requests/example/reply \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

id
required
string
Media typeapplication/json
object

Example generated

{}

Done.

Media typeapplication/json
object
createdAt
string
updatedAt
string
receipt
required
One of:
object
href
required
string
check
required
string
after
required
string
lang
required
One of:
string
cancelled
required
One of:
object
at
required
string
completed
required
Array<string>
pinnedAt
One of:
string
archivedAt
One of:
string
project
One of:
string
shared
boolean
id
required
string
words
required
string
kind
required
One of:
string
status
required
string
pending
required
One of:
object
kind
required
string
Allowed values: said
actor
required
string
Allowed values: person
words
required
string
turns
required
Array
One of:
object
kind
required
string
Allowed values: said
actor
required
string
Allowed values: person
words
required
string
ending
required
One of:
object
state
required
string
Allowed values: done
proof
required
object
check
required
string
before
required
One of:
string
after
required
string
at
required
string
answered
boolean
endingWords
required
string
attempts
required
One of:
number
counters
required
object
questions
required
number
personSteps
required
number
xovrisSteps
required
number
report
required
One of:
object
outcome
required
string
Allowed values: fixed answered done_by_you handed_on
title
required
string
what
required
Array<string>
test
object
name
required
string
before
required
Array<string>
after
required
Array<string>
passed
required
boolean
tried
required
Array<object>
object
approach
required
string
result
required
string
putBack
required
boolean
undo
required
One of:
string
sources
required
Array<object>
object
title
required
string
url
required
string
site
string
date
One of:
string
cites
Array<Array<number>>
next
required
One of:
string
offer
One of:
object
label
required
string
says
required
string
action
required
One of:
object
kind
required
string
Allowed values: ask
words
required
string
routes
required
string
needs
required
Array
One of:
object
kind
required
string
Allowed values: connect
what
required
string
Allowed values: dns server cloud code device site mailbox
words
required
string
href
required
string
changes
required
boolean
policy
required
string
Allowed values: by_itself asks_first off
consent
One of:
string
asksFirstFor
One of:
string
yourself
required
One of:
string
object
One of:
object
kind
required
string
Allowed values: domain device account service site package
name
required
string
change
One of:
object
where
required
string
before
required
Array<object>
object
field
required
string
value
required
string
after
required
Array<object>
object
field
required
string
value
required
string
severity
One of:
object
level
required
string
Allowed values: high medium low critical healthy
score
required
One of:
number
basis
required
string
vector
required
One of:
string
cites
required
Array<number>
from
string
Allowed values: read reported
forms
Array
One of:
object
kind
required
string
Allowed values: chart
title
required
string
unit
required
string
series
required
Array<object>
object
name
required
string
points
required
Array
read
required
string
pin
required
object
label
required
string
tile
required
object
form
required
string
Allowed values: map steps result code fixes timeline geo diff compare chart gantt calculator table stat heatmap diagram working
title
required
string
door
required
string
args
required
object
key
additional properties
One of:
string
pick
One of:
object
label
required
string
fact
required
string
options
required
Array<string>
picked
required
One of:
string
chart
string
Allowed values: area line bar pie scatter
x
string
Allowed values: number category time
stacked
boolean
marks
Array<object>
object
at
required
string
kind
required
string
Allowed values: incident change deploy
words
required
string
evidence
Array<object>
object
what
required
string
source
required
string
url
required
One of:
string
at
required
One of:
string
by
required
string
Allowed values: record page xovris
path
One of:
object
kind
required
string
Allowed values: request dns mail code link
hops
required
Array<object>
object
kind
required
string
name
required
string
state
required
One of:
string
Allowed values: high medium low critical healthy
detail
required
One of:
string
diff
One of:
object
where
required
string
lines
required
Array<object>
object
op
required
string
Allowed values: add del same
text
required
string
score
required
One of:
object
name
required
string
before
required
number
after
required
number
unit
required
string
better
required
string
Allowed values: higher lower
suggestions
Array<object>
object
kind
required
string
Allowed values: severity owner related duplicate
label
required
string
why
required
string
cites
required
Array<object>
object
id
required
string
title
required
string
href
required
string
accept
required
One of:
object
label
required
string
action
required
One of:
object
kind
required
string
Allowed values: ask
words
required
string
routes
required
string
parts
object
format
required
number
Allowed values: 1
lead
required
string
severity
required
One of:
object
level
required
string
Allowed values: high medium low critical healthy
score
required
One of:
number
basis
required
string
vector
required
One of:
string
cites
required
Array<number>
from
string
Allowed values: read reported
sections
required
Array<object>
object
id
required
string
Allowed values: records checks severity read affected aliases findings fix what answer mine fine
heading
required
string
lines
required
Array<object>
object
text
required
string
cites
required
Array<number>
checks
required
Array<object>
object
platform
required
string
where
required
string
command
required
string
reads
required
string
state
One of:
string
Allowed values: high medium low critical healthy
result
One of:
string
findings
required
Array<object>
object
text
required
string
cites
required
Array<number>
steps
required
Array<object>
object
words
required
string
by
required
string
Allowed values: xovris you
state
required
string
Allowed values: done failed offered undone doing
proof
required
One of:
string
undo
required
One of:
string
object
One of:
object
kind
required
string
Allowed values: domain device account service site package
name
required
string
change
One of:
object
where
required
string
before
required
Array<object>
object
field
required
string
value
required
string
after
required
Array<object>
object
field
required
string
value
required
string
verified
One of:
object
check
required
string
passed
required
boolean
before
required
One of:
string
after
required
One of:
string
undo
One of:
object
says
required
string
action
required
One of:
object
kind
required
string
Allowed values: ask
words
required
string
routes
required
string
forms
Array
One of:
object
kind
required
string
Allowed values: chart
title
required
string
unit
required
string
series
required
Array<object>
object
name
required
string
points
required
Array
read
required
string
pin
required
object
label
required
string
tile
required
object
form
required
string
Allowed values: map steps result code fixes timeline geo diff compare chart gantt calculator table stat heatmap diagram working
title
required
string
door
required
string
args
required
pick
One of:
object
label
required
string
fact
required
string
options
required
Array<string>
picked
required
One of:
string
chart
string
Allowed values: area line bar pie scatter
x
string
Allowed values: number category time
stacked
boolean
marks
Array<object>
object
at
required
string
kind
required
string
Allowed values: incident change deploy
words
required
string
evidence
Array<object>
object
what
required
string
source
required
string
url
required
One of:
string
at
required
One of:
string
by
required
string
Allowed values: record page xovris
path
One of:
object
kind
required
string
Allowed values: request dns mail code link
hops
required
Array<object>
object
kind
required
string
name
required
string
state
required
One of:
string
Allowed values: high medium low critical healthy
detail
required
One of:
string
diff
One of:
object
where
required
string
lines
required
Array<object>
object
op
required
string
Allowed values: add del same
text
required
string
score
required
One of:
object
name
required
string
before
required
number
after
required
number
unit
required
string
better
required
string
Allowed values: higher lower
chips
Array<object>
object
name
required
string
passed
required
boolean
says
required
string
cites
required
Array<number>
health
One of:
object
counts
required
object
high
required
number
medium
required
number
low
required
number
critical
required
number
healthy
required
number
total
required
number
worst
required
string
Allowed values: high medium low critical healthy
label
required
string
transcript
Array<object>
object
n
required
number
kind
required
string
Allowed values: plan read research consent question guide asked change setup said answered blocked remembered
by
required
string
Allowed values: xovris you
words
required
string
ok
required
One of:
boolean
detail
required
Array<string>
suggestions
Array<object>
object
kind
required
string
Allowed values: severity owner related duplicate
label
required
string
why
required
string
cites
required
Array<object>
object
id
required
string
title
required
string
href
required
string
accept
required
One of:
object
label
required
string
action
required
followUps
Array<object>
object
question
required
string
options
required
Array<object>
object
label
required
string
why
string
preview
string
recommended
required
number
why
string
many
boolean
blocker
required
One of:
object
kind
required
string
Allowed values: consent third_party safety law
says
required
string
wouldRemove
required
string
source
object
title
required
string
url
required
string
offered
required
Array<string>
explanation
required
object
wrong
required
Array<string>
evidence
required
Array<object>
object
step
required
string
ok
required
boolean
read
required
string
detail
required
Array<string>
doing
required
Array<string>
changed
required
Array<string>
tests
required
Array<object>
object
name
required
string
passed
required
boolean
before
required
Array<string>
after
required
Array<string>
uncertain
required
Array<string>
details
required
One of:
string
round
required
number
earlier
required
Array<object>
object
round
required
number
words
required
string
kind
required
One of:
string
status
required
string
title
required
One of:
string
ending
required
One of:
object
state
required
string
Allowed values: done
proof
required
object
check
required
string
before
required
One of:
string
after
required
string
at
required
string
answered
boolean
learnedFrom
required
One of:
object
layer
required
string
Allowed values: yours global
canAct
required
boolean
plan
required
One of:
object
message
required
One of:
string
next
required
One of:
string
context
required
One of:
object
route
required
string
record
object
type
required
string
Allowed values: connection incident asset device issue monitor
id
required
string
pictures
required
Array<object>
object
slot
required
number
mediaType
required
string
size
required
number
name
required
One of:
string
sha256
required
string
url
required
string

Example

{  "createdAt": "string",  "updatedAt": "string",  "receipt": {    "href": "string",    "check": "string",    "after": "string"  },  "lang": "string",  "cancelled": {    "at": "string",    "completed": [      "string"    ]  },  "pinnedAt": "string",  "archivedAt": "string",  "project": "string",  "shared": true,  "id": "string",  "words": "string",  "kind": "string",  "status": "string",  "pending": {    "kind": "said",    "actor": "person",    "words": "string"  },  "turns": [    {      "kind": "said",      "actor": "person",      "words": "string"    }  ],  "ending": {    "state": "done",    "proof": {      "check": "string",      "before": "string",      "after": "string",      "at": "string",      "answered": true    }  },  "endingWords": "string",  "attempts": 1,  "counters": {    "questions": 1,    "personSteps": 1,    "xovrisSteps": 1  },  "report": {    "outcome": "fixed",    "title": "string",    "what": [      "string"    ],    "test": {      "name": "string",      "before": [        "string"      ],      "after": [        "string"      ],      "passed": true    },    "tried": [      {        "approach": "string",        "result": "string",        "putBack": true      }    ],    "undo": "string",    "sources": [      {        "title": "string",        "url": "string",        "site": "string",        "date": "string"      }    ],    "cites": [      [        1      ]    ],    "next": "string",    "offer": {      "label": "string",      "says": "string",      "action": {        "kind": "ask",        "words": "string",        "routes": "string"      },      "needs": [        {          "kind": "connect",          "what": "dns",          "words": "string",          "href": "string"        }      ],      "changes": true,      "policy": "by_itself",      "consent": "string",      "asksFirstFor": "string",      "yourself": "string"    },    "object": {      "kind": "domain",      "name": "string"    },    "change": {      "where": "string",      "before": [        {          "field": "string",          "value": "string"        }      ],      "after": [        {          "field": "string",          "value": "string"        }      ]    },    "severity": {      "level": "high",      "score": 1,      "basis": "string",      "vector": "string",      "cites": [        1      ],      "from": "read"    },    "forms": [      {        "kind": "chart",        "title": "string",        "unit": "string",        "series": [          {            "name": "string",            "points": [              null            ]          }        ],        "read": "string",        "pin": {          "label": "string",          "tile": {            "form": "map",            "title": "string",            "door": "string",            "args": {}          }        },        "pick": {          "label": "string",          "fact": "string",          "options": [            null          ],          "picked": null        },        "chart": "area",        "x": "number",        "stacked": true,        "marks": [          {            "at": "string",            "kind": "incident",            "words": "string"          }        ]      }    ],    "evidence": [      {        "what": "string",        "source": "string",        "url": "string",        "at": "string",        "by": "record"      }    ],    "path": {      "kind": "request",      "hops": [        {          "kind": "string",          "name": "string",          "state": "high",          "detail": "string"        }      ]    },    "diff": {      "where": "string",      "lines": [        {          "op": "add",          "text": "string"        }      ],      "score": {        "name": "string",        "before": 1,        "after": 1,        "unit": "string",        "better": "higher"      }    },    "suggestions": [      {        "kind": "severity",        "label": "string",        "why": "string",        "cites": [          {            "id": "string",            "title": "string",            "href": "string"          }        ],        "accept": {          "label": "string",          "action": {            "kind": null,            "words": null,            "routes": null          }        }      }    ],    "parts": {      "format": 1,      "lead": "string",      "severity": {        "level": "high",        "score": 1,        "basis": "string",        "vector": "string",        "cites": [          1        ],        "from": "read"      },      "sections": [        {          "id": "records",          "heading": "string",          "lines": [            {              "text": "string",              "cites": [                null              ]            }          ]        }      ],      "checks": [        {          "platform": "string",          "where": "string",          "command": "string",          "reads": "string",          "state": "high",          "result": "string"        }      ],      "findings": [        {          "text": "string",          "cites": [            1          ]        }      ],      "steps": [        {          "words": "string",          "by": "xovris",          "state": "done",          "proof": "string",          "undo": "string"        }      ],      "object": {        "kind": "domain",        "name": "string"      },      "change": {        "where": "string",        "before": [          {            "field": "string",            "value": "string"          }        ],        "after": [          {            "field": "string",            "value": "string"          }        ]      },      "verified": {        "check": "string",        "passed": true,        "before": "string",        "after": "string"      },      "undo": {        "says": "string",        "action": {          "kind": "ask",          "words": "string",          "routes": "string"        }      },      "forms": [        {          "kind": "chart",          "title": "string",          "unit": "string",          "series": [            {              "name": null,              "points": null            }          ],          "read": "string",          "pin": {            "label": "string",            "tile": {              "form": null,              "title": null,              "door": null,              "args": null            }          },          "pick": {            "label": null,            "fact": null,            "options": null,            "picked": null          },          "chart": "area",          "x": "number",          "stacked": true,          "marks": [            {              "at": null,              "kind": null,              "words": null            }          ]        }      ],      "evidence": [        {          "what": "string",          "source": "string",          "url": "string",          "at": "string",          "by": "record"        }      ],      "path": {        "kind": "request",        "hops": [          {            "kind": "string",            "name": "string",            "state": null,            "detail": null          }        ]      },      "diff": {        "where": "string",        "lines": [          {            "op": "add",            "text": "string"          }        ],        "score": {          "name": "string",          "before": 1,          "after": 1,          "unit": "string",          "better": "higher"        }      },      "chips": [        {          "name": "string",          "passed": true,          "says": "string",          "cites": [            1          ]        }      ],      "health": {        "counts": {          "high": 1,          "medium": 1,          "low": 1,          "critical": 1,          "healthy": 1        },        "total": 1,        "worst": "high",        "label": "string"      },      "transcript": [        {          "n": 1,          "kind": "plan",          "by": "xovris",          "words": "string",          "ok": true,          "detail": [            "string"          ]        }      ],      "suggestions": [        {          "kind": "severity",          "label": "string",          "why": "string",          "cites": [            {              "id": "string",              "title": "string",              "href": "string"            }          ],          "accept": {            "label": "string",            "action": null          }        }      ]    },    "followUps": [      {        "question": "string",        "options": [          {            "label": "string",            "why": "string",            "preview": "string"          }        ],        "recommended": 1,        "why": "string",        "many": true      }    ]  },  "blocker": {    "kind": "consent",    "says": "string",    "wouldRemove": "string",    "source": {      "title": "string",      "url": "string"    },    "offered": [      "string"    ]  },  "explanation": {    "wrong": [      "string"    ],    "evidence": [      {        "step": "string",        "ok": true,        "read": "string",        "detail": [          "string"        ]      }    ],    "doing": [      "string"    ],    "changed": [      "string"    ],    "tests": [      {        "name": "string",        "passed": true,        "before": [          "string"        ],        "after": [          "string"        ]      }    ],    "uncertain": [      "string"    ],    "details": "string"  },  "round": 1,  "earlier": [    {      "round": 1,      "words": "string",      "kind": "string",      "status": "string",      "title": "string",      "ending": {        "state": "done",        "proof": {          "check": "string",          "before": "string",          "after": "string",          "at": "string",          "answered": true        }      }    }  ],  "learnedFrom": {    "layer": "yours"  },  "canAct": true,  "plan": {    "message": "string",    "next": "string"  },  "context": {    "route": "string",    "record": {      "type": "connection",      "id": "string"    }  },  "pictures": [    {      "slot": 1,      "mediaType": "string",      "size": 1,      "name": "string",      "sha256": "string",      "url": "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.