用於建立一個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
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。