See how Xovris would connect what you name, before anything changes
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/connect/plan';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"target":null,"way":null,"reply":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/connect/plan \ --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.
Authorizations
Section titled “Authorizations”Request Body
Section titled “Request Body”object
Example
{ "target": null, "way": null, "reply": null}Responses
Section titled “Responses”Done.
object
object
object
object
object
object
object
object
Example
{ "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.
object
Example generated
{}Started: the answer says where to follow it.
object
Example generated
{}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.