Skip to content

Read one guide: Do this for me first, with Do it yourself instead beneath it

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/autonomy/guides/{integration}
curl --request GET \  --url https://api.xovris.ai/v1/autonomy/guides/example \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

integration
required
string

Done.

Media typeapplication/json
object
integration
required
string
title
required
string
doThisForMe
required
object
label
required
string
method
required
string
Allowed values: POST
path
required
string
Allowed values: /v1/setup/takeovers
body
required
object
integration
required
string
says
required
string
manual
required
object
heading
required
string
signIn
required
string
steps
required
Array<object>
object
n
required
number
id
required
string
words
required
string
never
required
Array<string>
expectedMinutes
required
number
source
required
object
docs
required
string
readAt
required
string
planDigest
required
string

Example

{  "integration": "string",  "title": "string",  "doThisForMe": {    "label": "string",    "method": "POST",    "path": "/v1/setup/takeovers",    "body": {      "integration": "string"    }  },  "says": "string",  "manual": {    "heading": "string",    "signIn": "string",    "steps": [      {        "n": 1,        "id": "string",        "words": "string"      }    ]  },  "never": [    "string"  ],  "expectedMinutes": 1,  "source": {    "docs": "string",    "readAt": "string"  },  "planDigest": "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.