更新已有PolarClaw定时任务的配置,支持部分字段更新。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ApplicationId |
string |
是 |
应用 ID |
pa-xxx |
| JobId |
string |
是 |
要更新的定时任务 ID |
0ee00f56-f467-4d41-858c-ca4ede2c770e |
| Name |
string |
否 |
新任务名称 |
afternoon-report |
| Schedule |
object |
否 |
调度配置 |
{"Kind":"cron","Expr":"0 12 * * *","Tz":"America/New_York"} |
| Kind |
string |
否 |
调度类型 |
cron |
| Expr |
string |
否 |
cron 表达式 |
0 9 * * * |
| Tz |
string |
否 |
时区 |
Asia/Shanghai |
| StaggerMs |
integer |
否 |
确定性抖动窗口(毫秒) |
0 |
| EveryMs |
integer |
否 |
间隔毫秒数(Kind=every 时必填) |
100000 |
| AnchorMs |
integer |
否 |
间隔对齐基准时间戳(毫秒) |
1777370572518 |
| At |
string |
否 |
ISO 8601 时间戳(Kind=at 时必填,如 2026-04-10T09:00:00+08:00) |
2026-04-10T09:00:00+08:00 |
| SessionTarget |
string |
否 |
新会话目标 |
isolated |
| WakeMode |
string |
否 |
新唤醒模式 |
now |
| Payload |
object |
否 |
新执行载荷配置 |
{"Kind":"agentTurn","Message":"Updated: Generate afternoon report."} |
| Kind |
string |
否 |
载荷类型: |
agentTurn |
| Message |
string |
否 |
Agent 对话的提示词( |
Generate the daily report and send it to the team. |
| Text |
string |
否 |
系统事件的文本( |
Send a reminder to the user. |
| Model |
string |
否 |
模型覆盖 |
anthropic/sonnet-4.6 |
| Fallbacks |
array |
否 |
备选模型列表 |
|
|
string |
否 |
备选模型 |
modelA |
|
| Thinking |
string |
否 |
思考级别: |
medium |
| TimeoutSeconds |
integer |
否 |
执行超时秒数 |
10 |
| LightContext |
boolean |
否 |
是否使用轻量上下文 |
false |
| Deliver |
boolean |
否 |
是否投递输出到通道 |
false |
| Channel |
string |
否 |
投递通道 ID |
telegram |
| To |
string |
否 |
投递目标 |
team |
| BestEffortDeliver |
boolean |
否 |
投递失败是否忽略 |
|
| AgentId |
string |
否 |
新执行 Agent |
work |
| SessionKey |
string |
否 |
会话路由键 |
agent:main:feishu:direct:*** |
| Description |
string |
否 |
任务描述 |
Daily report generation |
| Enabled |
boolean |
否 |
新启用状态 |
false |
| DeleteAfterRun |
boolean |
否 |
新首次执行后删除标志 |
true |
| Delivery |
object |
否 |
结果投递配置 |
{"Mode":"announce","Channel":"telegram"} |
| Mode |
string |
否 |
投递模式: |
announce |
| Channel |
string |
否 |
投递通道 |
telegram |
| AccountId |
string |
否 |
通道账户 ID(可为空) |
accountId123 |
| To |
string |
否 |
投递目标(webhook 模式为 URL,必填) |
https://example.com/webhook |
| BestEffort |
boolean |
否 |
投递失败是否忽略 |
false |
| FailureAlert |
object |
否 |
失败告警配置;设为 |
{"After":3,"Channel":"telegram"} |
| After |
integer |
否 |
连续失败 N 次后告警 |
3 |
| Channel |
string |
否 |
告警通道 |
|
| AccountId |
string |
否 |
通道账户 ID |
accountId123 |
| To |
string |
否 |
告警目标 |
user@example.com |
| CooldownMs |
integer |
否 |
两次告警的最小间隔(毫秒) |
5000 |
| Mode |
string |
否 |
告警模式:announce / webhook |
announce |
| Restart |
boolean |
否 |
创建后是否重启网关,默认 true |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
Id of the request |
2281C6C9-CBAB-1AFD-8400-670750CF6025_2212 |
| Message |
string |
成功信息 |
successful |
| Code |
integer |
HTTP 状态码 |
200 |
| ApplicationId |
string |
应用 ID |
pa-************** |
| Ok |
boolean |
操作是否成功 |
true |
| Job |
object |
更新后的任务详情 |
|
| Id |
string |
任务 ID(UUID) |
0ee00f56-f467-4d41-858c-ca4ede2c770e |
| Name |
string |
任务名称 |
daily-report |
| Enabled |
boolean |
是否启用 |
false |
| DeleteAfterRun |
boolean |
是否在首次执行后删除 |
false |
| CreatedAtMs |
integer |
创建时间戳(毫秒) |
1777368967284 |
| UpdatedAtMs |
integer |
更新时间戳(毫秒) |
1777370572517 |
| Schedule |
object |
调度配置 |
|
| Kind |
string |
调度类型: |
cron |
| Expr |
string |
cron 表达式( |
0 9 * * * |
| Tz |
string |
IANA 时区(如 |
Asia/Shanghai |
| EveryMs |
integer |
间隔毫秒数( |
100000 |
| AnchorMs |
integer |
间隔对齐基准时间戳(毫秒) |
1777370572518 |
| At |
string |
ISO 8601 时间戳( |
2026-04-10T09:00:00+08:00 |
| SessionTarget |
string |
会话目标: |
main |
| WakeMode |
string |
唤醒模式: |
now |
| Payload |
object |
执行载荷配置对象 |
|
| Kind |
string |
载荷类型: |
agentTurn |
| Message |
string |
Agent 对话提示词 |
Generate the daily report. |
| Text |
string |
系统事件文本 |
Generate the daily report. |
| Model |
string |
模型覆盖 |
anthropic/sonnet-4.6 |
| TimeoutSeconds |
integer |
执行超时秒数(可为空) |
10 |
| LightContext |
boolean |
是否使用轻量上下文 |
false |
| Deliver |
boolean |
是否投递输出到通道 |
false |
| Channel |
string |
投递通道 ID(可为空) |
telegram |
| To |
string |
投递目标(可为空) |
team |
| BestEffortDeliver |
boolean |
投递失败是否忽略 |
false |
| AgentId |
string |
执行 Agent ID(可为空) |
work |
| SessionKey |
string |
会话路由键(可为空) |
abc123 |
| Description |
string |
任务描述(可为空) |
Daily report generation |
| Delivery |
object |
结果投递配置(可为空) |
|
| Mode |
string |
投递模式: |
announce |
| Channel |
string |
投递通道 |
telegram |
| AccountId |
string |
通道账户 ID(可为空) |
default |
| To |
string |
投递目标(webhook 模式为 URL,必填) |
https://example.com/webhook |
| BestEffort |
boolean |
投递失败是否忽略 |
|
| State |
object |
运行状态 |
|
| NextRunAtMs |
integer |
下次执行时间戳(毫秒) |
1777424400000 |
| LastRunAtMs |
integer |
上次执行时间戳(毫秒,可为空) |
1777370544931 |
| LastRunStatus |
string |
上次执行状态(可为空) |
ok |
| ConsecutiveErrors |
integer |
连续失败次数 |
0 |
| Runs |
array<object> |
运行历史(仅 IncludeRuns=true 时返回) |
|
|
array<object> |
|||
| Ts |
integer |
运行时间戳(毫秒) |
1777370572518 |
| JobId |
string |
关联任务 ID |
0ee00f56-f467-4d41-858c-ca4ede2c770e |
| Action |
string |
动作:finished / error / skipped |
finished |
| Status |
string |
状态:ok / error / skipped |
ok |
| Summary |
string |
运行摘要文本 |
Report generated successfully. |
| Delivered |
boolean |
是否已投递 |
true |
| DeliveryStatus |
string |
投递状态 |
delivered |
| SessionId |
string |
关联会话 ID |
abc123 |
| RunAtMs |
integer |
实际执行时间戳(毫秒) |
1777370544931 |
| DurationMs |
integer |
执行耗时(毫秒) |
27586 |
| NextRunAtMs |
integer |
下次执行时间戳(毫秒) |
1777424400000 |
| Model |
string |
使用的模型 |
anthropic/sonnet-4.6 |
| Provider |
string |
模型提供商 |
anthropic |
| Usage |
object |
Token 用量详情(可为空) |
|
| InputTokens |
integer |
输入 token 数量 |
30250 |
| OutputTokens |
integer |
输出 token 数量 |
30250 |
| TotalTokens |
integer |
总 token 数量 |
60500 |
| JobName |
string |
任务名称 |
daily-report |
示例
正常返回示例
JSON格式
{
"RequestId": "2281C6C9-CBAB-1AFD-8400-670750CF6025_2212",
"Message": "successful",
"Code": 200,
"ApplicationId": "pa-**************",
"Ok": true,
"Job": {
"Id": "0ee00f56-f467-4d41-858c-ca4ede2c770e",
"Name": "daily-report",
"Enabled": false,
"DeleteAfterRun": false,
"CreatedAtMs": 1777368967284,
"UpdatedAtMs": 1777370572517,
"Schedule": {
"Kind": "cron",
"Expr": "0 9 * * *",
"Tz": "Asia/Shanghai",
"EveryMs": 100000,
"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": "anthropic/sonnet-4.6",
"TimeoutSeconds": 10,
"LightContext": false,
"Deliver": false,
"Channel": "telegram",
"To": "team",
"BestEffortDeliver": false
},
"AgentId": "work",
"SessionKey": "abc123",
"Description": "Daily report generation",
"Delivery": {
"Mode": "announce",
"Channel": "telegram",
"AccountId": "default",
"To": "https://example.com/webhook",
"BestEffort": true
},
"State": {
"NextRunAtMs": 1777424400000,
"LastRunAtMs": 1777370544931,
"LastRunStatus": "ok",
"ConsecutiveErrors": 0
},
"Runs": [
{
"Ts": 1777370572518,
"JobId": "0ee00f56-f467-4d41-858c-ca4ede2c770e",
"Action": "finished",
"Status": "ok",
"Summary": "Report generated successfully.",
"Delivered": true,
"DeliveryStatus": "delivered",
"SessionId": "abc123",
"RunAtMs": 1777370544931,
"DurationMs": 27586,
"NextRunAtMs": 1777424400000,
"Model": "anthropic/sonnet-4.6",
"Provider": "anthropic",
"Usage": {
"InputTokens": 30250,
"OutputTokens": 30250,
"TotalTokens": 60500
},
"JobName": "daily-report"
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。