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.
const url = 'https://api.xovris.ai/v1/systems/profiles';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"provider":null,"sourceUrl":null,"document":null,"mcpTools":null,"connectionId":null,"credential":null,"baseUrl":null,"context":null}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Request Body
Section titled “Request Body”object
Example
{ "provider": null, "sourceUrl": null, "document": null, "mcpTools": null, "connectionId": null, "credential": null, "baseUrl": null, "context": null}Responses
Section titled “Responses”Done: something new was made, and the answer is it.
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.