Create a workflow schedule
curl --request POST \
--url https://inference.studio.lyzr.ai/api/workflow-schedules \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"workflow_id": "<string>",
"cron_expression": "0 9 * * 1",
"timezone": "Asia/Kolkata",
"max_retries": 123,
"retry_delay": 123
}
'import requests
url = "https://inference.studio.lyzr.ai/api/workflow-schedules"
payload = {
"workflow_id": "<string>",
"cron_expression": "0 9 * * 1",
"timezone": "Asia/Kolkata",
"max_retries": 123,
"retry_delay": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflow_id: '<string>',
cron_expression: '0 9 * * 1',
timezone: 'Asia/Kolkata',
max_retries: 123,
retry_delay: 123
})
};
fetch('https://inference.studio.lyzr.ai/api/workflow-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://inference.studio.lyzr.ai/api/workflow-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([
'workflow_id' => '<string>',
'cron_expression' => '0 9 * * 1',
'timezone' => 'Asia/Kolkata',
'max_retries' => 123,
'retry_delay' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://inference.studio.lyzr.ai/api/workflow-schedules"
payload := strings.NewReader("{\n \"workflow_id\": \"<string>\",\n \"cron_expression\": \"0 9 * * 1\",\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 123,\n \"retry_delay\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://inference.studio.lyzr.ai/api/workflow-schedules")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"<string>\",\n \"cron_expression\": \"0 9 * * 1\",\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 123,\n \"retry_delay\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inference.studio.lyzr.ai/api/workflow-schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"<string>\",\n \"cron_expression\": \"0 9 * * 1\",\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 123,\n \"retry_delay\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workflow_id": "<string>",
"cron_expression": "<string>",
"timezone": "<string>",
"is_active": true,
"max_retries": 123,
"retry_delay": 123,
"run_count": 123,
"last_run_at": "<string>",
"next_run_time": "<string>",
"user_id": "<string>",
"org_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Schedules
Create Schedule
Registers a recurring cron-driven trigger for a workflow. The caller’s identity is pinned to the schedule and re-verified on every tick; losing execute access deactivates the schedule rather than running as a stale principal. Only one schedule can exist per workflow, so creating a new one cancels and deletes any prior schedule for the same workflow.
POST
/
workflow-schedules
Create a workflow schedule
curl --request POST \
--url https://inference.studio.lyzr.ai/api/workflow-schedules \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"workflow_id": "<string>",
"cron_expression": "0 9 * * 1",
"timezone": "Asia/Kolkata",
"max_retries": 123,
"retry_delay": 123
}
'import requests
url = "https://inference.studio.lyzr.ai/api/workflow-schedules"
payload = {
"workflow_id": "<string>",
"cron_expression": "0 9 * * 1",
"timezone": "Asia/Kolkata",
"max_retries": 123,
"retry_delay": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflow_id: '<string>',
cron_expression: '0 9 * * 1',
timezone: 'Asia/Kolkata',
max_retries: 123,
retry_delay: 123
})
};
fetch('https://inference.studio.lyzr.ai/api/workflow-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://inference.studio.lyzr.ai/api/workflow-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([
'workflow_id' => '<string>',
'cron_expression' => '0 9 * * 1',
'timezone' => 'Asia/Kolkata',
'max_retries' => 123,
'retry_delay' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://inference.studio.lyzr.ai/api/workflow-schedules"
payload := strings.NewReader("{\n \"workflow_id\": \"<string>\",\n \"cron_expression\": \"0 9 * * 1\",\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 123,\n \"retry_delay\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://inference.studio.lyzr.ai/api/workflow-schedules")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"<string>\",\n \"cron_expression\": \"0 9 * * 1\",\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 123,\n \"retry_delay\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://inference.studio.lyzr.ai/api/workflow-schedules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"<string>\",\n \"cron_expression\": \"0 9 * * 1\",\n \"timezone\": \"Asia/Kolkata\",\n \"max_retries\": 123,\n \"retry_delay\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"workflow_id": "<string>",
"cron_expression": "<string>",
"timezone": "<string>",
"is_active": true,
"max_retries": 123,
"retry_delay": 123,
"run_count": 123,
"last_run_at": "<string>",
"next_run_time": "<string>",
"user_id": "<string>",
"org_id": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Tenant API key. Required on every endpoint.
Body
application/json
Schedule definition
⌘I