PolarClaw 定期タスクを作成します。
操作説明
リクエスト
この API を使用して cron ジョブを作成します。ジョブのペイロード、実行頻度、タイムゾーン、ターゲットチャンネル、受信者、および失敗時のアラート機構を設定できます。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
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 |
| WakeMode |
string |
必須 |
エージェントのウェイクモード。有効値は |
now |
| Payload |
object |
必須 |
実行ペイロード構成。 |
{"Kind":"agentTurn","Message":"Generate the daily report."} |
| Kind |
string |
任意 |
ペイロードの種類。有効値は |
systemEvent |
| Message |
string |
任意 |
|
Generate the daily report. |
| Text |
string |
任意 |
|
Generate the daily report. |
| Model |
string |
任意 |
エージェントのデフォルトモデルをオーバーライドするモデルを指定します。 |
bailian/qwen3.5-plus |
| Fallbacks |
array |
任意 |
プライマリモデルが失敗した場合に使用するフォールバックモデルのリスト。 |
|
|
string |
任意 |
フォールバックモデル。 |
bailian/qwen-max |
|
| Thinking |
string |
任意 |
エージェントの応答生成における思考レベル。有効値は |
xhigh |
| TimeoutSeconds |
integer |
任意 |
実行タイムアウト(秒単位)。 |
10 |
| LightContext |
boolean |
任意 |
エージェント会話で軽量コンテキストを使用するかどうかを指定します。 |
false |
| Deliver |
boolean |
任意 |
エージェントの出力をチャンネルに配信するかどうかを指定します。 |
true |
| Channel |
string |
任意 |
配信チャンネルの ID。 |
feishu |
| To |
string |
任意 |
チャンネル内の特定のターゲットまたは受信者。 |
ou_*** |
| BestEffortDeliver |
boolean |
任意 |
ベストエフォート型配信を使用するかどうかを指定します。 |
false |
| AgentId |
string |
任意 |
タスクを実行するエージェントの ID。 |
main |
| SessionKey |
string |
任意 |
タスクの会話セッションを決定するセッションルーティングキー。 |
agent:main:feishu:direct:*** |
| Description |
string |
任意 |
タスクの説明。 |
Daily report generation |
| Enabled |
boolean |
任意 |
cron ジョブを有効にするかどうかを指定します。デフォルト値は |
true |
| DeleteAfterRun |
boolean |
任意 |
最初の実行後にジョブを自動的に削除するかどうかを指定します。ワンタイムタスクに便利です。デフォルト値は |
false |
| Delivery |
object |
任意 |
タスク実行結果の配信構成。 |
{"Mode":"announce","Channel":"telegram"} |
| Mode |
string |
任意 |
配信モード。有効値は |
announce |
| Channel |
string |
任意 |
配信チャンネル。 |
feishu |
| AccountId |
string |
任意 |
配信チャンネルのアカウント ID。 |
default |
| To |
string |
任意 |
配信先の受信者。 |
ou_*** |
| BestEffort |
boolean |
任意 |
ベストエフォート型配信を使用するかどうかを指定します。 |
false |
| FailureAlert |
object |
任意 |
失敗時のアラート設定。 |
{"After":3,"Channel":"telegram"} |
| After |
integer |
任意 |
アラートをトリガーするために必要な連続失敗回数。 |
3 |
| Channel |
string |
任意 |
失敗アラートを送信するチャンネル。 |
feishu |
| AccountId |
string |
任意 |
アラートチャンネルのアカウント ID。 |
default |
| To |
string |
任意 |
失敗アラートの受信者。 |
ou_*** |
| CooldownMs |
integer |
任意 |
同じジョブに対するアラート間のクールダウン期間(ミリ秒単位)。 |
5000 |
| Mode |
string |
任意 |
アラート送信モード。有効値は |
announce |
| RunImmediately |
boolean |
任意 |
作成時にジョブを一度だけ即時実行するかどうかを指定します。デフォルト値は |
false |
| Restart |
boolean |
任意 |
ジョブ作成時にゲートウェイを再起動するかどうかを指定します。デフォルト値は |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答スキーマ。 |
||
| RequestId |
string |
リクエスト ID。 |
6BD9CDE4-5E7B-4BF3-9BB8-83C73E****** |
| Message |
string |
応答メッセージ。 |
successful |
| Code |
integer |
応答状態コード。 |
200 |
| ApplicationId |
string |
アプリケーション ID。 |
pa-************** |
| Ok |
boolean |
操作が成功したかどうかを示します。 |
true |
| Job |
object |
作成された cron ジョブの詳細。 |
|
| Id |
string |
ジョブ ID (UUID)。 |
e2c57423-12f0-45cc-a387-6155168b3201 |
| Name |
string |
ジョブ名。 |
test |
| Enabled |
boolean |
cron ジョブが有効かどうかを示します。 |
true |
| DeleteAfterRun |
boolean |
cron ジョブが最初の実行後に削除されるかどうかを示します。 |
false |
| CreatedAtMs |
integer |
作成タイムスタンプ(ミリ秒単位)。 |
1777368967284 |
| UpdatedAtMs |
integer |
更新タイムスタンプ(ミリ秒単位)。 |
1777370572517 |
| Schedule |
object |
スケジュール構成。 |
|
| Kind |
string |
スケジュールの種類。有効値: |
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 |
| WakeMode |
string |
ウェイクモード。有効値: |
now |
| Payload |
object |
実行ペイロード。 |
|
| Kind |
string |
ペイロードの種類。有効値: |
agentTurn |
| Message |
string |
エージェントプロンプト。 |
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 |
実行エージェントの ID。 |
main |
| SessionKey |
string |
セッションキー。 |
agent:main:feishu:direct:*** |
| Description |
string |
ジョブの説明。 |
test |
| Delivery |
object |
配信構成。 |
|
| Mode |
string |
配信モード。有効値: |
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 |
| Status |
string |
実行ステータス。有効値: |
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 |
トークン使用量の詳細。 |
|
| InputTokens |
integer |
入力トークン数。 |
30250 |
| OutputTokens |
integer |
出力トークン数。 |
30250 |
| TotalTokens |
integer |
トークン総数。 |
60500 |
| JobName |
string |
ジョブ名。 |
test |
| RanImmediately |
boolean |
ジョブが作成後に即時実行されたかどうかを示します。 |
false |
例
成功レスポンス
JSONJSON
{
"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
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。