Skip to content

Connect a system by what it publishes

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/systems/profiles
curl --request POST \  --url https://api.xovris.ai/v1/systems/profiles \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "provider": null, "sourceUrl": null, "document": null, "mcpTools": null, "connectionId": null, "credential": null, "baseUrl": null, "context": 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
provider
sourceUrl
document
mcpTools
connectionId
credential
baseUrl
context

Example

{  "provider": null,  "sourceUrl": null,  "document": null,  "mcpTools": null,  "connectionId": null,  "credential": null,  "baseUrl": null,  "context": null}

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

Media typeapplication/json
object
apiChanges
required
One of:
object
gated
required
object
message
required
string
next
required
string
connectionId
required
string
createdConnection
required
boolean
provider
required
string
title
required
string
source
required
object
kind
required
string
Allowed values: docs mcp graphql openapi
url
required
string
sha256
required
string
readAt
required
string
counts
required
object
reads
required
number
actions
required
number
byClass
required
object
R0
required
number
R1
required
number
R2
required
number
R3
required
number
R4
required
number
undoable
required
number
proved
required
number
credential
required
string
reads
required
Array<object>
object
id
required
string
reads
required
string
shape
required
string
Allowed values: list item
operation
required
string
watch
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: state flag measure
words
required
string
actions
required
Array<object>
object
id
required
string
title
required
string
verb
required
string
resource
required
string
reversibility
required
string
Allowed values: R0 R1 R2 R3 R4
why
required
string
undo
required
One of:
string
runsOnItsOwn
required
boolean
proved
required
object
ok
required
boolean
refused
required
boolean
detail
required
string
operation
required
string
rejected
required
Array<object>
object
ref
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
skipped
required
Array<object>
object
operation
required
string
why
required
string

Example

{  "apiChanges": {    "gated": {      "message": "string",      "next": "string"    }  },  "connectionId": "string",  "createdConnection": true,  "provider": "string",  "title": "string",  "source": {    "kind": "docs",    "url": "string",    "sha256": "string",    "readAt": "string"  },  "counts": {    "reads": 1,    "actions": 1,    "byClass": {      "R0": 1,      "R1": 1,      "R2": 1,      "R3": 1,      "R4": 1    },    "undoable": 1  },  "proved": 1,  "credential": "string",  "reads": [    {      "id": "string",      "reads": "string",      "shape": "list",      "operation": "string"    }  ],  "watch": [    {      "id": "string",      "kind": "state",      "words": "string"    }  ],  "actions": [    {      "id": "string",      "title": "string",      "verb": "string",      "resource": "string",      "reversibility": "R0",      "why": "string",      "undo": "string",      "runsOnItsOwn": true,      "proved": {        "ok": true,        "refused": true,        "detail": "string"      },      "operation": "string"    }  ],  "rejected": [    {      "ref": "string",      "issues": [        {          "path": "string",          "message": "string"        }      ]    }  ],  "skipped": [    {      "operation": "string",      "why": "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.