Skip to content

Read a conversation someone shared with a link

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/conversations/{token}
curl --request GET \  --url https://api.xovris.ai/v1/public/conversations/example

No token needed: anyone may call this.

token
required
string

Done.

Media typeapplication/json
object
state
required
string
conversation
required
object
title
required
string
at
required
string
lines
required
Array<object>
object
who
required
string
Allowed values: person xovris
text
required
string
steps
Array<string>
outcome
required
One of:
string
expiresAt
required
One of:
string
removed
required
object
email
number
id
number
secret
number
ip
number

Example

{  "state": "string",  "conversation": {    "title": "string",    "at": "string",    "lines": [      {        "who": "person",        "text": "string",        "steps": [          "string"        ]      }    ],    "outcome": "string",    "expiresAt": "string"  },  "removed": {    "email": 1,    "id": 1,    "secret": 1,    "ip": 1  }}

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.