Steer a computer session while it works, by your own words said or typed - its next step reads them; Esc alone takes it back
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/computer/sessions/example/steer';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"words":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/computer/sessions/example/steer \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "words": 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”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Request Body
Section titled “Request Body”object
Example
{ "words": null}Responses
Section titled “Responses”Started: the answer says where to follow it.
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
Example
{ "session": { "frame": "string", "working": true, "replayAt": "string", "id": "string", "goal": "string", "schedule": "string", "skill": "string", "held": true, "teach": true, "on": { "kind": "cloud" }, "state": "done", "steps": [ { "step": { "session": "string", "seq": 1, "do": "type", "target": { "window": "string", "program": "string" }, "x": 1, "y": 1, "toX": 1, "toY": 1, "text": "string", "keys": [ "string" ], "url": "string", "dy": 1, "ms": 1, "why": "string", "control": { "role": "string", "name": "string" }, "evidence": "string", "commits": "string" }, "outcome": "done", "words": "string", "at": "string", "taught": true } ], "front": { "window": "string", "program": "string", "url": "string" }, "by": "string", "startedAt": "string", "expires": "string", "endedAt": "string", "handBack": "string", "signed": { "task": null, "signature": "string" }, "desk": "string", "takenBy": "viewer", "notes": [ "string" ], "replay": true, "replayRemoved": { "at": "string", "frames": 1 }, "replayGaps": [ 1 ], "said": [ { "words": "string", "at": "string" } ], "replies": [ { "words": "string", "at": "string" } ], "engineAt": "string", "request": "string", "ran": { "by": "attached", "harness": "string" }, "tab": { "seq": 1, "said": "string" }, "group": [ { "key": "string", "title": "string", "url": "string", "at": "string" } ], "confirm": { "seq": 1, "commits": "string", "at": "string", "answer": "yes", "step": { "x": 1, "keys": [ "string" ], "text": "string", "target": { "window": "string", "program": "string" }, "url": "string", "why": "string", "evidence": "string", "ms": 1, "y": 1, "control": { "role": "string", "name": "string" }, "do": "type", "toX": 1, "toY": 1, "commits": "string", "dy": 1 } }, "planted": [ { "where": "string", "rule": "string", "excerpt": "string", "at": "string" } ] }, "words": "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.