Membuat tugas terjadwal PolarClaw.
Deskripsi operasi
Permintaan
Gunakan API ini untuk membuat cron job. Anda dapat mengonfigurasi payload job, frekuensi eksekusi, zona waktu, channel target, penerima, dan mekanisme peringatan kegagalan.
Coba sekarang
Test
RAM authorization
Sintaks permintaan
POST HTTP/1.1
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| ApplicationId |
string |
Yes |
ID aplikasi. |
pa-************** |
| Name |
string |
Yes |
Nama unik tugas. |
daily-report |
| Schedule |
object |
Yes |
Konfigurasi jadwal. |
{"Kind":"cron","Expr":"0 9 * * *","Tz":"Asia/Shanghai"} |
| Kind |
string |
No |
Jenis jadwal. |
cron |
| Expr |
string |
No |
Ekspresi cron yang menentukan kapan tugas dijalankan. |
0 9 * * * |
| Tz |
string |
No |
Zona waktu untuk jadwal. |
Asia/Shanghai |
| StaggerMs |
integer |
No |
Jendela jitter deterministik, dalam milidetik. |
0 |
| EveryMs |
integer |
No |
Interval eksekusi tugas, dalam milidetik. |
100000 |
| AnchorMs |
integer |
No |
Stempel waktu jangkar untuk menyelaraskan jadwal berbasis interval, dalam milidetik. |
1777370572518 |
| At |
string |
No |
Waktu spesifik untuk eksekusi satu kali, ditentukan sebagai stempel waktu ISO 8601. |
2026-04-10T09:00:00+08:00 |
| SessionTarget |
string |
Yes |
Target sesi. Nilai yang valid adalah |
main |
| WakeMode |
string |
Yes |
Mode bangun untuk agen. Nilai yang valid adalah |
now |
| Payload |
object |
Yes |
Konfigurasi payload eksekusi. |
{"Kind":"agentTurn","Message":"Generate the daily report."} |
| Kind |
string |
No |
Jenis payload. Nilai yang valid adalah |
systemEvent |
| Message |
string |
No |
Prompt untuk percakapan agen, digunakan ketika |
Generate the daily report. |
| Text |
string |
No |
Teks untuk event sistem, digunakan ketika |
Generate the daily report. |
| Model |
string |
No |
Menentukan model yang menggantikan model default agen. |
bailian/qwen3.5-plus |
| Fallbacks |
array |
No |
Daftar model fallback yang digunakan jika model utama gagal. |
|
|
string |
No |
Model fallback. |
bailian/qwen-max |
|
| Thinking |
string |
No |
Tingkat thinking untuk pembuatan respons agen. Nilai yang valid adalah |
xhigh |
| TimeoutSeconds |
integer |
No |
Batas waktu eksekusi, dalam detik. |
10 |
| LightContext |
boolean |
No |
Menentukan apakah akan menggunakan konteks ringan untuk percakapan agen. |
false |
| Deliver |
boolean |
No |
Menentukan apakah akan mengirimkan output agen ke sebuah channel. |
true |
| Channel |
string |
No |
ID channel pengiriman. |
feishu |
| To |
string |
No |
Target atau penerima spesifik dalam channel. |
ou_*** |
| BestEffortDeliver |
boolean |
No |
Menentukan apakah akan menggunakan pengiriman best-effort. Jika |
false |
| AgentId |
string |
No |
ID agen yang mengeksekusi tugas. |
main |
| SessionKey |
string |
No |
Kunci routing sesi, yang menentukan sesi percakapan untuk tugas. |
agent:main:feishu:direct:*** |
| Description |
string |
No |
Deskripsi tugas. |
Daily report generation |
| Enabled |
boolean |
No |
Menentukan apakah cron job diaktifkan. Default: |
true |
| DeleteAfterRun |
boolean |
No |
Menentukan apakah akan menghapus job secara otomatis setelah eksekusi pertamanya. Ini berguna untuk tugas satu kali. Default: |
false |
| Delivery |
object |
No |
Konfigurasi untuk mengirimkan hasil eksekusi tugas. |
{"Mode":"announce","Channel":"telegram"} |
| Mode |
string |
No |
Mode pengiriman. Nilai yang valid adalah |
announce |
| Channel |
string |
No |
Channel pengiriman. |
feishu |
| AccountId |
string |
No |
ID akun untuk channel pengiriman. |
default |
| To |
string |
No |
Penerima untuk pengiriman. |
ou_*** |
| BestEffort |
boolean |
No |
Menentukan apakah akan menggunakan pengiriman best-effort. Jika |
false |
| FailureAlert |
object |
No |
Konfigurasi peringatan kegagalan. |
{"After":3,"Channel":"telegram"} |
| After |
integer |
No |
Jumlah kegagalan berturut-turut yang diperlukan untuk memicu peringatan. |
3 |
| Channel |
string |
No |
Channel untuk mengirim peringatan kegagalan. |
feishu |
| AccountId |
string |
No |
ID akun untuk channel peringatan. |
default |
| To |
string |
No |
Penerima untuk peringatan kegagalan. |
ou_*** |
| CooldownMs |
integer |
No |
Periode cooldown, dalam milidetik, antara peringatan untuk job yang sama. |
5000 |
| Mode |
string |
No |
Mode untuk mengirim peringatan. Nilai yang valid adalah |
announce |
| RunImmediately |
boolean |
No |
Menentukan apakah akan menjalankan job satu kali segera setelah pembuatan. Default: |
false |
| Restart |
boolean |
No |
Menentukan apakah akan me-restart gateway saat pembuatan job. Default: |
true |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Skema respons. |
||
| RequestId |
string |
ID permintaan. |
6BD9CDE4-5E7B-4BF3-9BB8-83C73E****** |
| Message |
string |
Pesan respons. |
successful |
| Code |
integer |
Kode status respons. |
200 |
| ApplicationId |
string |
ID aplikasi. |
pa-************** |
| Ok |
boolean |
Menunjukkan apakah operasi berhasil. |
true |
| Job |
object |
Detail cron job yang dibuat. |
|
| Id |
string |
ID job (UUID). |
e2c57423-12f0-45cc-a387-6155168b3201 |
| Name |
string |
Nama job. |
test |
| Enabled |
boolean |
Menunjukkan apakah cron job diaktifkan. |
true |
| DeleteAfterRun |
boolean |
Menunjukkan apakah cron job dihapus setelah eksekusi pertamanya. |
false |
| CreatedAtMs |
integer |
Stempel waktu pembuatan dalam milidetik. |
1777368967284 |
| UpdatedAtMs |
integer |
Stempel waktu pembaruan dalam milidetik. |
1777370572517 |
| Schedule |
object |
Konfigurasi jadwal. |
|
| Kind |
string |
cron |
|
| Expr |
string |
0 9 * * * |
|
| Tz |
string |
Asia/Shanghai |
|
| EveryMs |
integer |
1000 |
|
| AnchorMs |
integer |
1777370572518 |
|
| At |
string |
2026-04-10T09:00:00+08:00 |
|
| SessionTarget |
string |
Target sesi. Nilai yang valid: |
main |
| WakeMode |
string |
Mode bangun. Nilai yang valid: |
now |
| Payload |
object |
Payload eksekusi. |
|
| 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 |
feishu |
|
| To |
string |
ou_*** |
|
| BestEffortDeliver |
boolean |
false |
|
| AgentId |
string |
ID agen yang mengeksekusi. |
main |
| SessionKey |
string |
Kunci sesi. |
agent:main:feishu:direct:*** |
| Description |
string |
Deskripsi job. |
test |
| Delivery |
object |
Konfigurasi pengiriman. |
|
| Mode |
string |
announce |
|
| Channel |
string |
feishu |
|
| AccountId |
string |
default |
|
| To |
string |
ou_*** |
|
| BestEffort |
boolean |
false |
|
| State |
object |
Status saat ini dari job. |
|
| NextRunAtMs |
integer |
1777424400000 |
|
| LastRunAtMs |
integer |
1777370544931 |
|
| LastRunStatus |
string |
ok |
|
| ConsecutiveErrors |
integer |
0 |
|
| Runs |
array<object> |
Riwayat eksekusi. |
|
|
array<object> |
|||
| Ts |
integer |
1777370572518 |
|
| JobId |
string |
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 |
*** |
|
| 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 |
Menunjukkan apakah job berjalan segera setelah pembuatan. |
false |
Contoh
Respons sukses
JSONformat
{
"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
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.