Skip to content

Turn a stopped schedule back on - its next run one cadence from now, its runs kept

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/computer/schedules/{id}/resume
curl --request POST \  --url https://api.xovris.ai/v1/computer/schedules/example/resume \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

id
required
string
Media typeapplication/json
object

Example generated

{}

Done.

Media typeapplication/json
object
schedule
required
object
id
required
string
goal
required
string
askedBy
required
One of:
string
next
required
One of:
string
everyMinutes
required
One of:
number
state
required
string
Allowed values: on off
settings
required
object
minutes
number
replay
boolean
screen
object
width
required
number
height
required
number
skill
string
runs
required
Array<object>
object
session
required
One of:
string
request
required
One of:
string
at
required
string
words
required
string
createdAt
required
string
words
required
string

Example

{  "schedule": {    "id": "string",    "goal": "string",    "askedBy": "string",    "next": "string",    "everyMinutes": 1,    "state": "on",    "settings": {      "minutes": 1,      "replay": true,      "screen": {        "width": 1,        "height": 1      },      "skill": "string"    },    "runs": [      {        "session": "string",        "request": "string",        "at": "string",        "words": "string"      }    ],    "createdAt": "string"  },  "words": "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.