Watch something, in your own words
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/watches';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"sentence":"string","idempotencyKey":"string"}'};
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/watches \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "sentence": "string", "idempotencyKey": "string" }'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
{ "sentence": "string", "idempotencyKey": "string"}Responses
Section titled “Responses”Done.
object
object
object
object
object
object
object
object
object
object
Example
{ "checkIn": { "url": "string", "shownOnce": true, "how": "string" }, "test": { "reached": 1, "sent": [ null ], "skipped": [ { "label": "string", "why": "string" } ], "testId": null }, "watch": { "id": "string", "kind": "heartbeat", "sentence": "string", "status": "on", "watches": "string", "source": "string", "observedByXovris": true, "firing": true, "now": "string", "lastLookedAt": "string", "lastTestedAt": "string", "nextLookAt": "string", "createdAt": "string", "createdBy": "string", "fix": { "label": "string", "method": "string", "path": "string", "keptVersion": "string" } }, "preview": { "watches": "string", "source": "string", "needs": "string", "every": "string", "alert": { "title": "string", "body": "string" } }, "created": true}Done: something new was made, and the answer is it.
object
object
object
object
object
object
object
object
object
object
Example
{ "checkIn": { "url": "string", "shownOnce": true, "how": "string" }, "test": { "reached": 1, "sent": [ null ], "skipped": [ { "label": "string", "why": "string" } ], "testId": null }, "watch": { "id": "string", "kind": "heartbeat", "sentence": "string", "status": "on", "watches": "string", "source": "string", "observedByXovris": true, "firing": true, "now": "string", "lastLookedAt": "string", "lastTestedAt": "string", "nextLookAt": "string", "createdAt": "string", "createdBy": "string", "fix": { "label": "string", "method": "string", "path": "string", "keptVersion": "string" } }, "preview": { "watches": "string", "source": "string", "needs": "string", "every": "string", "alert": { "title": "string", "body": "string" } }, "created": true}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.