すべてのプロダクト
Search
ドキュメントセンター

Qoder CN シリーズ:スケジュールの作成

最終更新日:Jul 04, 2026

繰り返し実行、または手動でトリガーできるテンプレート実行構成を作成します。

リクエストヘッダー

ヘッダー

必須

説明

Authorization

はい

Bearer <PAT>

Content-Type

はい

application/json

Idempotency-Key

いいえ

安全でないリクエスト用のオプションのべき等性キーです。

リクエストボディ

パラメーター

タイプ

必須

説明

identity_id

文字列

はい

スケジュールを所有する Forward アイデンティティ ID です。

template_id

文字列

はい

実行する Forward テンプレート ID です。

name

文字列

はい

スケジュール名です。

description

文字列

いいえ

スケジュールの説明です。

initial_events

配列

はい

各実行時に注入されるイベントです。現在の設計では user.message をサポートしています。

execution

オブジェクト

いいえ

実行ポリシーです。省略された場合はデフォルト値が適用されます。

trigger_policy

オブジェクト|null

いいえ

トリガーポリシーです。省略または null の場合は {"type":"manual"} になります。

environment_id

文字列

はい

実行環境です。

metadata

オブジェクト

いいえ

ラベルまたはパススルーデータ専用のカスタムメタデータです。

トリガーポリシー

type

必須入力

説明

cron

typeexpressiontimezone

指定された IANA タイムゾーンで、5 フィールドの cron 式に従って繰り返します。

once

typeexpression、オプションの timezone

ISO 8601 形式の時刻で 1 回実行します。式にオフセットがない場合は timezone が必要です。

interval

typeexpression

PT15M などの ISO 8601 期間に従って繰り返します。

manual

type

自動的には実行されません。Run Schedule エンドポイントを使用してトリガーする必要があります。

実行ポリシー

フィールド

タイプ

デフォルト

説明

session_mode

文字列

new_session

new_session または reuse_session

max_concurrent_runs

整数

1

このスケジュールの最大同時実行数です。

max_attempts

整数

1

予約済み。現在の実装では記録と検証を行いますが、実行は 1 回のみです。

timeout_ms

整数

300000

1 回の試行あたりのタイムアウトです。

リクエスト例

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": "日次技術概要",
    "description": "日次のテクノロジーニュースの概要を生成します",
    "initial_events": [
      {
        "type": "user.message",
        "content": "現在のテクノロジーニュースを 5 つの箇条書きで要約します。"
      }
    ],
    "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"
  }'

レスポンス例

HTTP 200 OK

{
  "id": "sched_019f00112233445566778899aabbccdd",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_support",
  "name": "日次技術概要",
  "description": "日次のテクノロジーニュースの概要を生成します",
  "status": "active",
  "paused_reason": null,
  "initial_events": [
    {
      "type": "user.message",
      "content": "現在のテクノロジーニュースを 5 つの箇条書きで要約します。"
    }
  ],
  "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"
}

エラー

HTTP

タイプ

コード

トリガー

400

invalid_request_error

invalid_trigger_policy

トリガーポリシーのタイプまたは式が無効です。

400

invalid_request_error

trigger_policy_too_frequent

トリガー間隔が 1 分未満です。

400

invalid_request_error

trigger_policy_time_too_soon

once のターゲット時刻が早すぎます。

400

invalid_request_error

unsupported_sinks_input

リクエストボディに シンク が含まれています。

404

not_found_error

identity_not_found

アイデンティティが存在しません。

404

not_found_error

template_not_found

テンプレートが存在しません。

401

authentication_error

authentication_required

個人アクセストークン (PAT) が無効であるか、有効期限が切れています。

注意事項

  • HTTP 作成リクエストは シンク を受け付けません。API で直接作成されたスケジュールは sinks: [] を返します。

  • manual スケジュールは POST /api/v1/forward/schedules/{schedule_id}/run でのみトリガーできます。

  • once スケジュールは、最初のスケジュール実行が終了状態に達すると自動的にアーカイブされます。