curl --request POST \
--url https://api.example.com/schedule/ \
--header 'Content-Type: application/json' \
--header 'x-user-id: <x-user-id>' \
--data '
{
"name": "<string>",
"cron_expression": "<string>",
"agent_id": "<string>",
"chat_model_config": {
"type": "<string>",
"credential_id": "<string>",
"model": "<string>",
"parameters": {}
},
"description": "",
"timezone": "UTC",
"enabled": true,
"stateful": false,
"permission_mode": "dont_ask"
}
'import requests
url = "https://api.example.com/schedule/"
payload = {
"name": "<string>",
"cron_expression": "<string>",
"agent_id": "<string>",
"chat_model_config": {
"type": "<string>",
"credential_id": "<string>",
"model": "<string>",
"parameters": {}
},
"description": "",
"timezone": "UTC",
"enabled": True,
"stateful": False,
"permission_mode": "dont_ask"
}
headers = {
"x-user-id": "<x-user-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-user-id': '<x-user-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cron_expression: '<string>',
agent_id: '<string>',
chat_model_config: {type: '<string>', credential_id: '<string>', model: '<string>', parameters: {}},
description: '',
timezone: 'UTC',
enabled: true,
stateful: false,
permission_mode: 'dont_ask'
})
};
fetch('https://api.example.com/schedule/', 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://api.example.com/schedule/",
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([
'name' => '<string>',
'cron_expression' => '<string>',
'agent_id' => '<string>',
'chat_model_config' => [
'type' => '<string>',
'credential_id' => '<string>',
'model' => '<string>',
'parameters' => [
]
],
'description' => '',
'timezone' => 'UTC',
'enabled' => true,
'stateful' => false,
'permission_mode' => 'dont_ask'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-user-id: <x-user-id>"
],
]);
$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://api.example.com/schedule/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"chat_model_config\": {\n \"type\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"model\": \"<string>\",\n \"parameters\": {}\n },\n \"description\": \"\",\n \"timezone\": \"UTC\",\n \"enabled\": true,\n \"stateful\": false,\n \"permission_mode\": \"dont_ask\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-user-id", "<x-user-id>")
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://api.example.com/schedule/")
.header("x-user-id", "<x-user-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"chat_model_config\": {\n \"type\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"model\": \"<string>\",\n \"parameters\": {}\n },\n \"description\": \"\",\n \"timezone\": \"UTC\",\n \"enabled\": true,\n \"stateful\": false,\n \"permission_mode\": \"dont_ask\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/schedule/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-user-id"] = '<x-user-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"chat_model_config\": {\n \"type\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"model\": \"<string>\",\n \"parameters\": {}\n },\n \"description\": \"\",\n \"timezone\": \"UTC\",\n \"enabled\": true,\n \"stateful\": false,\n \"permission_mode\": \"dont_ask\"\n}"
response = http.request(request)
puts response.read_body{
"schedule_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Create a new schedule
Create a new schedule and register it with the scheduler.
Args:
body (CreateScheduleRequest): Schedule configuration.
user_id (str): Authenticated user ID.
storage (StorageBase): Storage instance.
scheduler (SchedulerManager): Scheduler manager.
Returns:
CreateScheduleResponse:
The ID of the newly created schedule.
Raises:
HTTPException: 404 if the specified agent does not exist.
curl --request POST \
--url https://api.example.com/schedule/ \
--header 'Content-Type: application/json' \
--header 'x-user-id: <x-user-id>' \
--data '
{
"name": "<string>",
"cron_expression": "<string>",
"agent_id": "<string>",
"chat_model_config": {
"type": "<string>",
"credential_id": "<string>",
"model": "<string>",
"parameters": {}
},
"description": "",
"timezone": "UTC",
"enabled": true,
"stateful": false,
"permission_mode": "dont_ask"
}
'import requests
url = "https://api.example.com/schedule/"
payload = {
"name": "<string>",
"cron_expression": "<string>",
"agent_id": "<string>",
"chat_model_config": {
"type": "<string>",
"credential_id": "<string>",
"model": "<string>",
"parameters": {}
},
"description": "",
"timezone": "UTC",
"enabled": True,
"stateful": False,
"permission_mode": "dont_ask"
}
headers = {
"x-user-id": "<x-user-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-user-id': '<x-user-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cron_expression: '<string>',
agent_id: '<string>',
chat_model_config: {type: '<string>', credential_id: '<string>', model: '<string>', parameters: {}},
description: '',
timezone: 'UTC',
enabled: true,
stateful: false,
permission_mode: 'dont_ask'
})
};
fetch('https://api.example.com/schedule/', 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://api.example.com/schedule/",
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([
'name' => '<string>',
'cron_expression' => '<string>',
'agent_id' => '<string>',
'chat_model_config' => [
'type' => '<string>',
'credential_id' => '<string>',
'model' => '<string>',
'parameters' => [
]
],
'description' => '',
'timezone' => 'UTC',
'enabled' => true,
'stateful' => false,
'permission_mode' => 'dont_ask'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-user-id: <x-user-id>"
],
]);
$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://api.example.com/schedule/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"chat_model_config\": {\n \"type\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"model\": \"<string>\",\n \"parameters\": {}\n },\n \"description\": \"\",\n \"timezone\": \"UTC\",\n \"enabled\": true,\n \"stateful\": false,\n \"permission_mode\": \"dont_ask\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-user-id", "<x-user-id>")
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://api.example.com/schedule/")
.header("x-user-id", "<x-user-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"chat_model_config\": {\n \"type\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"model\": \"<string>\",\n \"parameters\": {}\n },\n \"description\": \"\",\n \"timezone\": \"UTC\",\n \"enabled\": true,\n \"stateful\": false,\n \"permission_mode\": \"dont_ask\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/schedule/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-user-id"] = '<x-user-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cron_expression\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"chat_model_config\": {\n \"type\": \"<string>\",\n \"credential_id\": \"<string>\",\n \"model\": \"<string>\",\n \"parameters\": {}\n },\n \"description\": \"\",\n \"timezone\": \"UTC\",\n \"enabled\": true,\n \"stateful\": false,\n \"permission_mode\": \"dont_ask\"\n}"
response = http.request(request)
puts response.read_body{
"schedule_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.
Body
Request body for creating a new schedule.
Display name of the schedule.
Standard 5-field cron expression, e.g. '0 9 * * 1-5'.
Agent to run when the schedule fires.
Model configuration for the auto-created session.
Show child attributes
Show child attributes
Optional description.
IANA timezone name, e.g. 'America/New_York' or 'Asia/Shanghai'.
Whether the schedule is active immediately after creation.
If True, consecutive executions share the same session context.
Permission level for the agent during scheduled execution.
default, accept_edits, explore, bypass, dont_ask Response
Successful Response
Response body after creating a schedule.
Server-assigned schedule identifier.