Create Schedule

Create schedule

curl --request POST \
  --url https://scheduler.studio.lyzr.ai/schedules/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data @- <<EOF
{
  "user_id": "user@example.com",
  "agent_id": "66e9b0f2a1c3d4e5f6a7b8c9",
  "cron_expression": "0 9 * * 1-5",
  "message": "Summarize yesterday's support tickets and flag anything urgent.",
  "timezone": "Asia/Kolkata",
  "max_retries": 3,
  "retry_delay": 60
}
EOF

import requests

url = "https://scheduler.studio.lyzr.ai/schedules/"

payload = {
    "user_id": "user@example.com",
    "agent_id": "66e9b0f2a1c3d4e5f6a7b8c9",
    "cron_expression": "0 9 * * 1-5",
    "message": "Summarize yesterday's support tickets and flag anything urgent.",
    "timezone": "Asia/Kolkata",
    "max_retries": 3,
    "retry_delay": 60
}
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({
    user_id: 'user@example.com',
    agent_id: '66e9b0f2a1c3d4e5f6a7b8c9',
    cron_expression: '0 9 * * 1-5',
    message: 'Summarize yesterday\'s support tickets and flag anything urgent.',
    timezone: 'Asia/Kolkata',
    max_retries: 3,
    retry_delay: 60
  })
};

fetch('https://scheduler.studio.lyzr.ai/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://scheduler.studio.lyzr.ai/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([
    'user_id' => 'user@example.com',
    'agent_id' => '66e9b0f2a1c3d4e5f6a7b8c9',
    'cron_expression' => '0 9 * * 1-5',
    'message' => 'Summarize yesterday\'s support tickets and flag anything urgent.',
    'timezone' => 'Asia/Kolkata',
    'max_retries' => 3,
    'retry_delay' => 60
  ]),
  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://scheduler.studio.lyzr.ai/schedules/"

	payload := strings.NewReader("{\n  \"user_id\": \"user@example.com\",\n  \"agent_id\": \"66e9b0f2a1c3d4e5f6a7b8c9\",\n  \"cron_expression\": \"0 9 * * 1-5\",\n  \"message\": \"Summarize yesterday's support tickets and flag anything urgent.\",\n  \"timezone\": \"Asia/Kolkata\",\n  \"max_retries\": 3,\n  \"retry_delay\": 60\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://scheduler.studio.lyzr.ai/schedules/")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"user@example.com\",\n  \"agent_id\": \"66e9b0f2a1c3d4e5f6a7b8c9\",\n  \"cron_expression\": \"0 9 * * 1-5\",\n  \"message\": \"Summarize yesterday's support tickets and flag anything urgent.\",\n  \"timezone\": \"Asia/Kolkata\",\n  \"max_retries\": 3,\n  \"retry_delay\": 60\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://scheduler.studio.lyzr.ai/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  \"user_id\": \"user@example.com\",\n  \"agent_id\": \"66e9b0f2a1c3d4e5f6a7b8c9\",\n  \"cron_expression\": \"0 9 * * 1-5\",\n  \"message\": \"Summarize yesterday's support tickets and flag anything urgent.\",\n  \"timezone\": \"Asia/Kolkata\",\n  \"max_retries\": 3,\n  \"retry_delay\": 60\n}"

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

{
  "id": "66f1c2a9e4b0a1b2c3d4e5f6",
  "user_id": "user@example.com",
  "agent_id": "66e9b0f2a1c3d4e5f6a7b8c9",
  "message": "Summarize yesterday's support tickets and flag anything urgent.",
  "cron_expression": "0 9 * * 1-5",
  "timezone": "Asia/Kolkata",
  "created_at": "2023-11-07T05:31:56Z",
  "max_retries": 3,
  "retry_delay": 60,
  "is_active": true,
  "updated_at": "2023-11-07T05:31:56Z",
  "next_run_time": "2023-11-07T05:31:56Z",
  "last_run_at": "2023-11-07T05:31:56Z",
  "last_run_success": true
}

POST

schedules

Create schedule

curl --request POST \
  --url https://scheduler.studio.lyzr.ai/schedules/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data @- <<EOF
{
  "user_id": "user@example.com",
  "agent_id": "66e9b0f2a1c3d4e5f6a7b8c9",
  "cron_expression": "0 9 * * 1-5",
  "message": "Summarize yesterday's support tickets and flag anything urgent.",
  "timezone": "Asia/Kolkata",
  "max_retries": 3,
  "retry_delay": 60
}
EOF

import requests

url = "https://scheduler.studio.lyzr.ai/schedules/"

payload = {
    "user_id": "user@example.com",
    "agent_id": "66e9b0f2a1c3d4e5f6a7b8c9",
    "cron_expression": "0 9 * * 1-5",
    "message": "Summarize yesterday's support tickets and flag anything urgent.",
    "timezone": "Asia/Kolkata",
    "max_retries": 3,
    "retry_delay": 60
}
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({
    user_id: 'user@example.com',
    agent_id: '66e9b0f2a1c3d4e5f6a7b8c9',
    cron_expression: '0 9 * * 1-5',
    message: 'Summarize yesterday\'s support tickets and flag anything urgent.',
    timezone: 'Asia/Kolkata',
    max_retries: 3,
    retry_delay: 60
  })
};

fetch('https://scheduler.studio.lyzr.ai/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://scheduler.studio.lyzr.ai/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([
    'user_id' => 'user@example.com',
    'agent_id' => '66e9b0f2a1c3d4e5f6a7b8c9',
    'cron_expression' => '0 9 * * 1-5',
    'message' => 'Summarize yesterday\'s support tickets and flag anything urgent.',
    'timezone' => 'Asia/Kolkata',
    'max_retries' => 3,
    'retry_delay' => 60
  ]),
  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://scheduler.studio.lyzr.ai/schedules/"

	payload := strings.NewReader("{\n  \"user_id\": \"user@example.com\",\n  \"agent_id\": \"66e9b0f2a1c3d4e5f6a7b8c9\",\n  \"cron_expression\": \"0 9 * * 1-5\",\n  \"message\": \"Summarize yesterday's support tickets and flag anything urgent.\",\n  \"timezone\": \"Asia/Kolkata\",\n  \"max_retries\": 3,\n  \"retry_delay\": 60\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://scheduler.studio.lyzr.ai/schedules/")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"user@example.com\",\n  \"agent_id\": \"66e9b0f2a1c3d4e5f6a7b8c9\",\n  \"cron_expression\": \"0 9 * * 1-5\",\n  \"message\": \"Summarize yesterday's support tickets and flag anything urgent.\",\n  \"timezone\": \"Asia/Kolkata\",\n  \"max_retries\": 3,\n  \"retry_delay\": 60\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://scheduler.studio.lyzr.ai/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  \"user_id\": \"user@example.com\",\n  \"agent_id\": \"66e9b0f2a1c3d4e5f6a7b8c9\",\n  \"cron_expression\": \"0 9 * * 1-5\",\n  \"message\": \"Summarize yesterday's support tickets and flag anything urgent.\",\n  \"timezone\": \"Asia/Kolkata\",\n  \"max_retries\": 3,\n  \"retry_delay\": 60\n}"

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

{
  "id": "66f1c2a9e4b0a1b2c3d4e5f6",
  "user_id": "user@example.com",
  "agent_id": "66e9b0f2a1c3d4e5f6a7b8c9",
  "message": "Summarize yesterday's support tickets and flag anything urgent.",
  "cron_expression": "0 9 * * 1-5",
  "timezone": "Asia/Kolkata",
  "created_at": "2023-11-07T05:31:56Z",
  "max_retries": 3,
  "retry_delay": 60,
  "is_active": true,
  "updated_at": "2023-11-07T05:31:56Z",
  "next_run_time": "2023-11-07T05:31:56Z",
  "last_run_at": "2023-11-07T05:31:56Z",
  "last_run_success": true
}

Every time the schedule fires, the agent receives message as if a user had sent it. The schedule is active as soon as it is created. cron_expression uses standard five-field cron syntax, evaluated in timezone. See Cron expressions for the format and examples. To test the schedule without waiting for the next cron time, call Trigger Schedule Now.

Authorizations

x-api-key

string

header

required

Lyzr API key. Required on every endpoint except Trigger Webhook.

Body

application/json

user_id

string

required

User ID the agent runs on behalf of. Used to scope the agent's session and memory.

Example:

"user@example.com"

agent_id

string

required

ID of the agent to run.

Example:

"66e9b0f2a1c3d4e5f6a7b8c9"

cron_expression

string

required

Five-field cron expression: minute hour day month day_of_week. Day-of-week follows standard cron numbering (0 or 7 = Sunday, 1 = Monday, ..., 6 = Saturday).

Example:

"0 9 * * 1-5"

message

string

default:""

Message sent to the agent on every run.

Example:

"Summarize yesterday's support tickets and flag anything urgent."

timezone

string

default:UTC

IANA timezone the cron expression is evaluated in.

Example:

"Asia/Kolkata"

max_retries

integer

default:3

Number of retry attempts if a run fails (0-5).

Required range: 0 <= x <= 5

retry_delay

integer

default:60

Seconds to wait between retry attempts (10-3600).

Required range: 10 <= x <= 3600

Response

Schedule created.

string

required

Unique schedule ID.

Example:

"66f1c2a9e4b0a1b2c3d4e5f6"

user_id

string

required

Example:

"user@example.com"

agent_id

string

required

Example:

"66e9b0f2a1c3d4e5f6a7b8c9"

message

string

required

Example:

"Summarize yesterday's support tickets and flag anything urgent."

cron_expression

string

required

Example:

"0 9 * * 1-5"

timezone

string

required

Example:

"Asia/Kolkata"

created_at

string<date-time>

required

max_retries

integer

default:3

retry_delay

integer

default:60

is_active

boolean

default:true

false when the schedule is paused.

updated_at

string<date-time> | null

next_run_time

string<date-time> | null

When the schedule will next fire. null while paused.

last_run_at

string<date-time> | null

last_run_success

boolean | null

Outcome of the most recent run. null if the schedule has never run.

Agents

Sessions

Orchestration

Scheduler

Webhooks

Tools

Voice Agents

Knowledge Base

Knowledge Graph

Responsible & Safe AI

Create Schedule

Authorizations

Body

Response