用于创建一个PolarClaw定时任务。
接口说明
请求说明
通过此 API，用户可以定义并创建一个新的定时任务（Cron Job），该任务将根据给定的时间表定期触发，并携带特定的消息或指令。支持自定义任务的执行频率、时区设置以及失败后的警报机制等高级选项。此外，还可以配置消息的内容、目标渠道及接收者等详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ApplicationId |
string |
是 |
应用 ID |
pa-************** |
| Name |
string |
是 |
任务唯一名称 |
daily-report |
| Schedule |
object |
是 |
调度配置 |
{"Kind":"cron","Expr":"0 9 * * *","Tz":"Asia/Shanghai"} |
| Kind |
string |
否 |
调度类型 |
cron |
| Expr |
string |
否 |
cron 表达式 |
0 9 * * * |
| Tz |
string |
否 |
时区 |
Asia/Shanghai |
| StaggerMs |
integer |
否 |
确定性抖动窗口（毫秒） |
0 |
| EveryMs |
integer |
否 |
间隔毫秒数 |
100000 |
| AnchorMs |
integer |
否 |
间隔对齐基准时间戳 |
1777370572518 |
| At |
string |
否 |
ISO 8601 时间戳 |
2026-04-10T09:00:00+08:00 |
| SessionTarget |
string |
是 |
会话目标：main/isolated/current |
main |
| WakeMode |
string |
是 |
唤醒模式：now/next-heartbeat |
now |
| Payload |
object |
是 |
执行载荷配置 |
{"Kind":"agentTurn","Message":"Generate the daily report."} |
| Kind |
string |
否 |
载荷类型：agentTurn/systemEvent |
systemEvent |
| Message |
string |
否 |
Agent 对话提示词 |
Generate the daily report. |
| Text |
string |
否 |
系统事件文本 |
Generate the daily report. |
| Model |
string |
否 |
模型覆盖 |
bailian/qwen3.5-plus |
| Fallbacks |
array |
否 |
备选模型列表 |
|
|
string |
否 |
备选模型 |
bailian/qwen-max |
|
| Thinking |
string |
否 |
思考级别：off/minimal/low/medium/high/xhigh |
xhigh |
| TimeoutSeconds |
integer |
否 |
执行超时秒数 |
10 |
| LightContext |
boolean |
否 |
是否使用轻量上下文 |
false |
| Deliver |
boolean |
否 |
是否投递输出到通道 |
true |
| Channel |
string |
否 |
投递通道 ID |
feishu |
| To |
string |
否 |
投递目标 |
ou_*** |
| BestEffortDeliver |
boolean |
否 |
投递失败是否忽略 |
false |
| AgentId |
string |
否 |
指定执行 Agent |
main |
| SessionKey |
string |
否 |
会话路由键 |
agent:main:feishu:direct:*** |
| Description |
string |
否 |
任务描述 |
Daily report generation |
| Enabled |
boolean |
否 |
是否启用，默认 true |
true |
| DeleteAfterRun |
boolean |
否 |
首次执行后自动删除，默认 false |
false |
| Delivery |
object |
否 |
结果投递配置 |
{"Mode":"announce","Channel":"telegram"} |
| Mode |
string |
否 |
投递模式：none/announce/webhook |
announce |
| Channel |
string |
否 |
投递通道 |
feishu |
| AccountId |
string |
否 |
通道账户 ID |
default |
| To |
string |
否 |
投递目标 |
ou_*** |
| BestEffort |
boolean |
否 |
投递失败是否忽略 |
false |
| FailureAlert |
object |
否 |
失败告警配置 |
{"After":3,"Channel":"telegram"} |
| After |
integer |
否 |
连续失败 N 次后告警 |
3 |
| Channel |
string |
否 |
告警通道 |
feishu |
| AccountId |
string |
否 |
通道账户 ID |
default |
| To |
string |
否 |
告警目标 |
ou_*** |
| CooldownMs |
integer |
否 |
两次告警的最小间隔（毫秒） |
5000 |
| Mode |
string |
否 |
告警模式：announce/webhook |
announce |
| RunImmediately |
boolean |
否 |
是否创建后立即执行一次，默认 false |
false |
| Restart |
boolean |
否 |
创建后是否重启网关，默认 true |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
6BD9CDE4-5E7B-4BF3-9BB8-83C73E****** |
| Message |
string |
返回消息 |
successful |
| Code |
integer |
返回状态码 |
200 |
| ApplicationId |
string |
应用 ID |
pa-************** |
| Ok |
boolean |
操作是否成功 |
true |
| Job |
object |
创建的定时任务详情 |
|
| Id |
string |
任务 ID（UUID） |
e2c57423-12f0-45cc-a387-6155168b3201 |
| Name |
string |
任务名称 |
test |
| Enabled |
boolean |
是否启用 |
true |
| DeleteAfterRun |
boolean |
是否在首次执行后删除 |
false |
| CreatedAtMs |
integer |
创建时间戳（毫秒） |
1777368967284 |
| UpdatedAtMs |
integer |
更新时间戳（毫秒） |
1777370572517 |
| Schedule |
object |
调度配置 |
|
| Kind |
string |
调度类型：cron/every/at |
cron |
| Expr |
string |
cron 表达式 |
0 9 * * * |
| Tz |
string |
IANA 时区 |
Asia/Shanghai |
| EveryMs |
integer |
间隔毫秒数 |
1000 |
| AnchorMs |
integer |
间隔对齐基准时间戳 |
1777370572518 |
| At |
string |
ISO 8601 时间戳 |
2026-04-10T09:00:00+08:00 |
| SessionTarget |
string |
会话目标：main/isolated/current |
main |
| WakeMode |
string |
唤醒模式：now/next-heartbeat |
now |
| Payload |
object |
执行载荷 |
|
| Kind |
string |
载荷类型：agentTurn/systemEvent |
agentTurn |
| Message |
string |
Agent 对话提示词 |
Generate the daily report. |
| Text |
string |
系统事件文本 |
Generate the daily report. |
| Model |
string |
模型覆盖 |
bailian/qwen3.5-plus |
| TimeoutSeconds |
integer |
执行超时秒数 |
10 |
| LightContext |
boolean |
是否使用轻量上下文 |
false |
| Deliver |
boolean |
是否投递输出到通道 |
false |
| Channel |
string |
投递通道 ID |
feishu |
| To |
string |
投递目标 |
ou_*** |
| BestEffortDeliver |
boolean |
投递失败是否忽略 |
false |
| AgentId |
string |
执行 Agent ID |
main |
| SessionKey |
string |
会话路由键 |
agent:main:feishu:direct:*** |
| Description |
string |
任务描述 |
test |
| Delivery |
object |
结果投递配置 |
|
| Mode |
string |
投递模式：none/announce/webhook |
announce |
| Channel |
string |
投递通道 |
feishu |
| AccountId |
string |
通道账户 ID |
default |
| To |
string |
投递目标 |
ou_*** |
| BestEffort |
boolean |
投递失败是否忽略 |
false |
| State |
object |
运行状态 |
|
| NextRunAtMs |
integer |
下次执行时间戳（毫秒） |
1777424400000 |
| LastRunAtMs |
integer |
上次执行时间戳（毫秒） |
1777370544931 |
| LastRunStatus |
string |
上次执行状态 |
ok |
| ConsecutiveErrors |
integer |
连续失败次数 |
0 |
| Runs |
array<object> |
运行历史 |
|
|
array<object> |
|||
| Ts |
integer |
运行时间戳（毫秒） |
1777370572518 |
| JobId |
string |
关联任务 ID |
f83f5278-1abe-40a6-b10e-ad3ecdc05de2 |
| Action |
string |
动作：finished/error/skipped |
finished |
| Status |
string |
状态：ok/error/skipped |
ok |
| Summary |
string |
运行摘要文本 |
Generate the daily report. |
| Delivered |
boolean |
是否已投递 |
false |
| DeliveryStatus |
string |
投递状态 |
not-requested |
| SessionId |
string |
关联会话 ID |
*** |
| RunAtMs |
integer |
实际执行时间戳（毫秒） |
1777370544931 |
| DurationMs |
integer |
执行耗时（毫秒） |
27586 |
| NextRunAtMs |
integer |
下次执行时间戳（毫秒） |
1777424400000 |
| Model |
string |
使用的模型 |
bailian/qwen3.5-plus |
| Provider |
string |
模型提供商 |
bailian |
| Usage |
object |
Token 用量详情 |
|
| InputTokens |
integer |
输入 token 数量 |
30250 |
| OutputTokens |
integer |
输出 token 数量 |
30250 |
| TotalTokens |
integer |
总 token 数量 |
60500 |
| JobName |
string |
任务名称 |
test |
| RanImmediately |
boolean |
是否立即执行成功 |
false |
示例
正常返回示例
JSON格式
{
"RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-**************",
"Ok": true,
"Job": {
"Id": "e2c57423-12f0-45cc-a387-6155168b3201",
"Name": "test",
"Enabled": true,
"DeleteAfterRun": false,
"CreatedAtMs": 1777368967284,
"UpdatedAtMs": 1777370572517,
"Schedule": {
"Kind": "cron",
"Expr": "0 9 * * *",
"Tz": "Asia/Shanghai",
"EveryMs": 1000,
"AnchorMs": 1777370572518,
"At": "2026-04-10T09:00:00+08:00"
},
"SessionTarget": "main",
"WakeMode": "now",
"Payload": {
"Kind": "agentTurn",
"Message": "Generate the daily report.",
"Text": "Generate the daily report.",
"Model": "bailian/qwen3.5-plus",
"TimeoutSeconds": 10,
"LightContext": false,
"Deliver": false,
"Channel": "feishu",
"To": "ou_***",
"BestEffortDeliver": false
},
"AgentId": "main",
"SessionKey": "agent:main:feishu:direct:***",
"Description": "test",
"Delivery": {
"Mode": "announce",
"Channel": "feishu",
"AccountId": "default",
"To": "ou_***",
"BestEffort": false
},
"State": {
"NextRunAtMs": 1777424400000,
"LastRunAtMs": 1777370544931,
"LastRunStatus": "ok",
"ConsecutiveErrors": 0
},
"Runs": [
{
"Ts": 1777370572518,
"JobId": "f83f5278-1abe-40a6-b10e-ad3ecdc05de2",
"Action": "finished",
"Status": "ok",
"Summary": "Generate the daily report.",
"Delivered": false,
"DeliveryStatus": "not-requested",
"SessionId": "***",
"RunAtMs": 1777370544931,
"DurationMs": 27586,
"NextRunAtMs": 1777424400000,
"Model": "bailian/qwen3.5-plus",
"Provider": "bailian",
"Usage": {
"InputTokens": 30250,
"OutputTokens": 30250,
"TotalTokens": 60500
},
"JobName": "test"
}
]
},
"RanImmediately": false
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。