Create a schedule

Start an instance or a job later. Send run_at to run once, or cron (with timezone) to repeat. spec is the body of POST /instances or POST /jobs and is checked now, so a schedule that is accepted can launch. Every schedule needs spec.max_runtime_minutes, so nothing it starts runs unbounded. Runs start within about 2 minutes of their time, as you, through the credential you created it with: revoking that API key or ending that agent sign-in pauses the schedule. At most 50 schedules per environment and 200 per workspace.

POST

schedules

Create a schedule

curl --request POST \
  --url https://www.runcrate.ai/api/v1/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spec": {},
  "run_at": "2023-11-07T05:31:56Z",
  "cron": "<string>",
  "timezone": "UTC",
  "overlap": "skip",
  "name": "<string>",
  "enabled": true
}
'

import requests

url = "https://www.runcrate.ai/api/v1/schedules"

payload = {
    "spec": {},
    "run_at": "2023-11-07T05:31:56Z",
    "cron": "<string>",
    "timezone": "UTC",
    "overlap": "skip",
    "name": "<string>",
    "enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    spec: {},
    run_at: '2023-11-07T05:31:56Z',
    cron: '<string>',
    timezone: 'UTC',
    overlap: 'skip',
    name: '<string>',
    enabled: true
  })
};

fetch('https://www.runcrate.ai/api/v1/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.runcrate.ai/api/v1/schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'spec' => [
        
    ],
    'run_at' => '2023-11-07T05:31:56Z',
    'cron' => '<string>',
    'timezone' => 'UTC',
    'overlap' => 'skip',
    'name' => '<string>',
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.runcrate.ai/api/v1/schedules"

	payload := strings.NewReader("{\n  \"spec\": {},\n  \"run_at\": \"2023-11-07T05:31:56Z\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"overlap\": \"skip\",\n  \"name\": \"<string>\",\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.runcrate.ai/api/v1/schedules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spec\": {},\n  \"run_at\": \"2023-11-07T05:31:56Z\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"overlap\": \"skip\",\n  \"name\": \"<string>\",\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.runcrate.ai/api/v1/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"spec\": {},\n  \"run_at\": \"2023-11-07T05:31:56Z\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"overlap\": \"skip\",\n  \"name\": \"<string>\",\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "kind": "instance",
    "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "spec": {},
    "max_runtime_minutes": 2,
    "timezone": "UTC",
    "overlap": "skip",
    "enabled": true,
    "run_count": 1,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "run_as": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run_as_credential": "user",
    "run_at": "2023-11-07T05:31:56Z",
    "cron": "<string>",
    "next_run_at": "2023-11-07T05:31:56Z",
    "last_run_at": "2023-11-07T05:31:56Z",
    "last_status": "launched",
    "last_error": "<string>",
    "last_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Use a Runcrate API key with the rc_live_* prefix as the bearer token. Create one at https://www.runcrate.ai/dashboard/api-keys.

Body

application/json

Send exactly one of run_at (once) or cron (repeating).

kind

enum<string>

required

Available options:

instance,

job

spec

object

required

The body each run sends, checked now by the same rules as the create endpoint: a JobCreateRequest for kind: job, an InstanceCreateRequest for kind: instance. max_runtime_minutes is required for both (job: 1 to 1440; instance: 5 to 10080).

run_at

string<date-time>

Run once at this time. Must be a real calendar date (2027-02-30 is refused), in the future and at most 365 days ahead.

cron

string

Repeat on this 5-field cron expression, read in timezone. Occurrences must be at least 15 minutes apart. Supports *, a-b, */n, a-b/n, lists a,b, names JAN-DEC and SUN-SAT, day-of-week 0 to 7 (0 and 7 are Sunday).

timezone

string

default:UTC

IANA timezone, e.g. America/New_York. A time skipped by a daylight saving change runs at the same offset after the gap (02:30 runs at 03:30); a time that happens twice runs once, the first time.

overlap

enum<string>

default:skip

Repeating only. Skip a run while the previous run's instance or job is still live.

Available options:

skip,

allow

name

string

Defaults to spec.name, or instance-schedule / job-schedule.

Required string length: 1 - 63

enabled

boolean

default:true

Create it paused with false.

Response

Schedule created.

data

object

required

Starts an instance or a job later: once at run_at, or on every occurrence of cron in timezone. Runcrate checks schedules every 2 minutes, so a run starts within about 2 minutes of its time, as run_as through run_as_credential, in the environment it was created in. When many schedules are due at once, each workspace gets its turn.

Show child attributes

Create a schedule

curl --request POST \
  --url https://www.runcrate.ai/api/v1/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "spec": {},
  "run_at": "2023-11-07T05:31:56Z",
  "cron": "<string>",
  "timezone": "UTC",
  "overlap": "skip",
  "name": "<string>",
  "enabled": true
}
'

import requests

url = "https://www.runcrate.ai/api/v1/schedules"

payload = {
    "spec": {},
    "run_at": "2023-11-07T05:31:56Z",
    "cron": "<string>",
    "timezone": "UTC",
    "overlap": "skip",
    "name": "<string>",
    "enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    spec: {},
    run_at: '2023-11-07T05:31:56Z',
    cron: '<string>',
    timezone: 'UTC',
    overlap: 'skip',
    name: '<string>',
    enabled: true
  })
};

fetch('https://www.runcrate.ai/api/v1/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.runcrate.ai/api/v1/schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'spec' => [
        
    ],
    'run_at' => '2023-11-07T05:31:56Z',
    'cron' => '<string>',
    'timezone' => 'UTC',
    'overlap' => 'skip',
    'name' => '<string>',
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.runcrate.ai/api/v1/schedules"

	payload := strings.NewReader("{\n  \"spec\": {},\n  \"run_at\": \"2023-11-07T05:31:56Z\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"overlap\": \"skip\",\n  \"name\": \"<string>\",\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.runcrate.ai/api/v1/schedules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spec\": {},\n  \"run_at\": \"2023-11-07T05:31:56Z\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"overlap\": \"skip\",\n  \"name\": \"<string>\",\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.runcrate.ai/api/v1/schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"spec\": {},\n  \"run_at\": \"2023-11-07T05:31:56Z\",\n  \"cron\": \"<string>\",\n  \"timezone\": \"UTC\",\n  \"overlap\": \"skip\",\n  \"name\": \"<string>\",\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "kind": "instance",
    "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "spec": {},
    "max_runtime_minutes": 2,
    "timezone": "UTC",
    "overlap": "skip",
    "enabled": true,
    "run_count": 1,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "run_as": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run_as_credential": "user",
    "run_at": "2023-11-07T05:31:56Z",
    "cron": "<string>",
    "next_run_at": "2023-11-07T05:31:56Z",
    "last_run_at": "2023-11-07T05:31:56Z",
    "last_status": "launched",
    "last_error": "<string>",
    "last_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "last_job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Chat

Images

Videos

Audio

Embeddings

Models

Instances

Jobs

Schedules

Storage

Environments

Secrets

SSH Keys

Templates

Billing

Create a schedule

Authorizations

Body

Response