All Products
Search
Document Center

Seri Qoder CN:Buat jadwal

Last Updated:Jul 04, 2026

Buat konfigurasi eksekusi Templat yang dapat diulang atau dipicu secara manual.

Header permintaan

Header

Wajib

Deskripsi

Authorization

Ya

Bearer <PAT>

Content-Type

Ya

application/json

Idempotency-Key

Tidak

Kunci idempotensi opsional untuk permintaan yang tidak aman.

Body permintaan

Parameter

Tipe

Wajib

Deskripsi

identity_id

string

Ya

Forward Identity ID yang memiliki Jadwal ini.

template_id

string

Ya

Forward Template ID yang akan dieksekusi.

name

string

Ya

Nama jadwal.

description

string

Tidak

Deskripsi jadwal.

initial_events

array

Ya

Event yang disuntikkan pada setiap eksekusi. Desain saat ini mendukung user.message.

execution

object

Tidak

Kebijakan eksekusi. Nilai default diterapkan jika dihilangkan.

trigger_policy

object|null

Tidak

Kebijakan pemicu. Jika dihilangkan atau bernilai null, maka menjadi {"type":"manual"}.

environment_id

string

Ya

Lingkungan eksekusi.

metadata

object

Tidak

Metadata kustom hanya untuk label atau data pass-through.

Kebijakan pemicu

type

Input wajib

Deskripsi

cron

type, expression, timezone

Diulang berdasarkan ekspresi cron 5 field dalam zona waktu IANA yang ditentukan.

once

type, expression, timezone opsional

Dijalankan sekali pada waktu ISO 8601. timezone wajib jika ekspresi tidak memiliki offset.

interval

type, expression

Diulang berdasarkan durasi ISO 8601, seperti PT15M.

manual

type

Tidak pernah dijalankan secara otomatis. Picu melalui endpoint Run Schedule.

Kebijakan eksekusi

Bidang

Tipe

Default

Deskripsi

session_mode

string

new_session

new_session atau reuse_session.

max_concurrent_runs

integer

1

Jumlah maksimum eksekusi bersamaan untuk Jadwal ini.

max_attempts

integer

1

Disimpan untuk penggunaan mendatang. Implementasi saat ini mencatat dan memvalidasinya tetapi hanya menjalankan satu kali.

timeout_ms

integer

300000

Timeout untuk satu percobaan.

Contoh permintaan

curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/schedules' \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "identity_id": "idn_019eabc123",
    "template_id": "tmpl_support",
    "name": "Daily tech brief",
    "description": "Generate a daily technology news summary",
    "initial_events": [
      {
        "type": "user.message",
        "content": "Summarize current technology news in five bullet points."
      }
    ],
    "trigger_policy": {
      "type": "cron",
      "expression": "0 9 * * *",
      "timezone": "Asia/Shanghai"
    },
    "execution": {
      "session_mode": "new_session",
      "max_concurrent_runs": 1,
      "max_attempts": 1,
      "timeout_ms": 300000
    },
    "environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c"
  }'

Contoh respons

HTTP 200 OK

{
  "id": "sched_019f00112233445566778899aabbccdd",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_support",
  "name": "Daily tech brief",
  "description": "Generate a daily technology news summary",
  "status": "active",
  "paused_reason": null,
  "initial_events": [
    {
      "type": "user.message",
      "content": "Summarize current technology news in five bullet points."
    }
  ],
  "execution": {
    "session_mode": "new_session",
    "max_concurrent_runs": 1,
    "max_attempts": 1,
    "timeout_ms": 300000
  },
  "trigger_policy": {
    "type": "cron",
    "expression": "0 9 * * *",
    "timezone": "Asia/Shanghai",
    "upcoming_runs_at": ["2026-06-23T01:00:00Z"]
  },
  "environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
  "sinks": [],
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-06-22T10:00:00Z",
  "updated_at": "2026-06-22T10:00:00Z"
}

Kesalahan

HTTP

Tipe

Kode

Pemicu

400

invalid_request_error

invalid_trigger_policy

Tipe atau ekspresi kebijakan pemicu tidak valid.

400

invalid_request_error

trigger_policy_too_frequent

Interval pemicu kurang dari satu menit.

400

invalid_request_error

trigger_policy_time_too_soon

Waktu target once terlalu dekat.

400

invalid_request_error

unsupported_sinks_input

Body permintaan berisi sinks.

404

not_found_error

identity_not_found

Identitas tidak ditemukan.

404

not_found_error

template_not_found

Templat tidak ditemukan.

401

authentication_error

authentication_required

PAT tidak valid atau telah kedaluwarsa.

Catatan

  • Permintaan pembuatan HTTP tidak menerima sinks. Jadwal yang dibuat langsung melalui API mengembalikan sinks: [].

  • Jadwal manual hanya dapat dipicu dengan POST /api/v1/forward/schedules/{schedule_id}/run.

  • Jadwal once secara otomatis diarsipkan setelah eksekusi pertamanya mencapai status terminal.