Skip to content

Have Xovris's AI write the incident for each reader from its record (paid plans), each draft marked as written by Xovris

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/incidents/{id}/audiences/write
curl --request POST \  --url https://api.xovris.ai/v1/incidents/example/audiences/write \  --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

Example generated

{}

Done: something new was made, and the answer is it.

Media typeapplication/json
One of:
object
canWrite
required
boolean
writeBlocked
required
One of:
string
Allowed values: not_entitled ai_off
writeWhy
required
One of:
string
writing
required
boolean
id
required
string
audiences
required
Array<object>
object
audience
required
string
Allowed values: support owners customers responders
by
required
string
Allowed values: ai template
label
required
string
sentences
required
Array<object>
object
text
required
string
sources
required
Array<string>
mark
required
One of:
object
aiGenerated
required
boolean
generator
required
string
Allowed values: Xovris
label
required
string
draft
required
One of:
number
reviewed
required
One of:
object
by
required
string
at
required
string
publishable
required
boolean
at
required
One of:
string
updateState
required
string
Allowed values: resolved monitoring investigating identified
publicPage
required
One of:
string

Example

{  "canWrite": true,  "writeBlocked": "not_entitled",  "writeWhy": "string",  "writing": true,  "id": "string",  "audiences": [    {      "audience": "support",      "by": "ai",      "label": "string",      "sentences": [        {          "text": "string",          "sources": [            "string"          ]        }      ],      "mark": {        "aiGenerated": true,        "generator": "Xovris",        "label": "string"      },      "draft": 1,      "reviewed": {        "by": "string",        "at": "string"      },      "publishable": true,      "at": "string"    }  ],  "updateState": "resolved",  "publicPage": "string"}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

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.