Skip to content

Connect Xovris to anything you name: a web address, an API, a database, a device, a serial line, a webhook source or a service's name

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/connect
curl --request POST \  --url https://api.xovris.ai/v1/connect \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "target": null, "way": null, "reply": null }'

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

Media typeapplication/json
object
target
way
reply

Example

{  "target": null,  "way": null,  "reply": null}

Done.

Media typeapplication/json
One of:
object
way
required
string
Allowed values: basic browser device oauth api_key mcp webhook protocol database graphql openapi
plan
required
object
target
required
object
kind
required
string
Allowed values: name url device webhook database
name
string
url
string
device
object
door
required
string
host
required
string
port
required
One of:
number
user
required
One of:
string
path
required
One of:
string
shown
required
string
database
object
engine
required
string
host
required
string
port
required
One of:
number
database
required
One of:
string
user
required
One of:
string
options
required
object
key
additional properties
string
readOnly
required
string
ways
required
Array<object>
object
way
required
string
Allowed values: basic browser device oauth api_key mcp webhook protocol database graphql openapi
at
required
string
signIn
required
string
Allowed values: key none oauth consent password
evidence
required
string
detail
required
object
key
additional properties
chosen
required
object
way
required
string
Allowed values: basic browser device oauth api_key mcp webhook protocol database graphql openapi
at
required
string
signIn
required
string
Allowed values: key none oauth consent password
evidence
required
string
detail
required
object
key
additional properties
tried
required
Array<object>
object
at
required
string
answer
required
string
next
required
string
doItYourself
required
string

Example

{  "way": "basic",  "plan": {    "target": {      "kind": "name",      "name": "string",      "url": "string",      "device": {        "door": "string",        "host": "string",        "port": 1,        "user": "string",        "path": "string"      },      "shown": "string",      "database": {        "engine": "string",        "host": "string",        "port": 1,        "database": "string",        "user": "string",        "options": {},        "readOnly": "string"      }    },    "ways": [      {        "way": "basic",        "at": "string",        "signIn": "key",        "evidence": "string",        "detail": {}      }    ],    "chosen": {      "way": "basic",      "at": "string",      "signIn": "key",      "evidence": "string",      "detail": {}    },    "tried": [      {        "at": "string",        "answer": "string"      }    ],    "next": "string",    "doItYourself": "string"  }}

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

Media typeapplication/json
One of:
object
receives
One of:
Array<string>
connectionId
required
string
tools
required
Array<object>
object
name
required
string
class
required
string
Allowed values: billing read write
enabled
required
boolean
approved
required
boolean
disabledReason
required
One of:
string

Example

{  "receives": [    "string"  ],  "connectionId": "string",  "tools": [    {      "name": "string",      "class": "billing",      "enabled": true,      "approved": true,      "disabledReason": "string"    }  ]}

Started: the answer says where to follow it.

Media typeapplication/json
One of:
object
next
required
string
doItYourself
required
string
waiting
required
string

Example

{  "next": "string",  "doItYourself": "string",  "waiting": "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.