メインコンテンツへスキップ
POST /v1/deployments 新しい Deployment を作成します。Deployment は Agent を cron スケジュール（または手動トリガーのみ）、Environment、各実行時に配信される初期イベントセットにバインドします。新規作成された Deployment は active ステータスとなり、スケジュールに従って即座に実行を開始します。

​
ヘッダー

名称必須値
AuthorizationはいBearer $QODER_PAT
Content-Typeはいapplication/json

​
リクエストボディ

フィールド型必須説明
namestringはいDeployment 名(最大 256 文字)
descriptionstringいいえ人間が読める説明
agentstring or objectはいAgent 参照。プレーンな文字列 "agent_xxx"(最新バージョンを使用) またはオブジェクト {"id": "agent_xxx", "type": "agent", "version": 2} で特定バージョンを固定。
environment_idstringはいEnvironment ID(env_ プレフィックス)
scheduleobjectいいえCron スケジュール設定。省略時は手動トリガーのみとなります(レスポンスでは schedule が null)。下記 Schedule オブジェクト を参照。
initial_eventsarrayはい各実行時に Agent に配信されるイベントの配列(1-50 個)。各イベントには type フィールドが必要です。許容タイプ: user.message、user.define_outcome、system.message。
resourcesarrayいいえ各 Session に付加するリソース(例: github_repository、file、memory_store)。デフォルトは []。
vault_idsarrayいいえ認証情報を注入する Vault ID リスト。デフォルトは []、最大 50 個。
metadataobjectいいえカスタムのキーバリューメタデータ(最大 16 キー、キー ≤64 文字、値 ≤512 文字)。予約キー cas_config は制限の対象外で、CAS 固有の実行パラメータを制御します。

​
Schedule オブジェクト

フィールド型必須説明
typestringはい"cron" である必要があります
expressionstringはい標準 5 フィールドの cron 式(例: "0 9 * * *")
timezonestringはいIANA タイムゾーン(例: "Asia/Shanghai")

​
metadata.cas_config (CAS 拡張)

metadata 内の cas_config キーは CAS 固有の実行動作を制御します:
フィールド型デフォルト説明
session_strategystring"new_session"Session 再利用戦略
config.max_retriesinteger0失敗時の最大リトライ回数
config.timeout_msinteger300000実行タイムアウト(ミリ秒)
config.max_concurrentinteger1最大同時実行数

​
リクエスト例

curl -X POST "https://api.qoder.com/api/v1/cloud/deployments" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "api-doc-verification-deployment",
    "description": "Deployment created for API documentation verification",
    "agent": "agent_019eb4d4a06d747c865d5800b9c57ae2",
    "environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
    "schedule": {
      "type": "cron",
      "expression": "0 9 * * *",
      "timezone": "Asia/Shanghai"
    },
    "initial_events": [
      {"type": "user.message", "content": "Generate today'\''s status report"}
    ],
    "resources": [],
    "vault_ids": [],
    "metadata": {}
  }'

​
レスポンス例

HTTP 200 OK 
{
  "agent": {
    "id": "agent_019eb4d4a06d747c865d5800b9c57ae2",
    "type": "agent",
    "version": 1
  },
  "archived_at": null,
  "created_at": "2026-06-14T08:53:32Z",
  "description": "Deployment created for API documentation verification",
  "environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
  "id": "dep_019ec556114c78f8b60ee34fcb98bf59",
  "initial_events": [
    {
      "content": "Generate today's status report",
      "type": "user.message"
    }
  ],
  "metadata": {
    "cas_config": {
      "config": {
        "max_concurrent": 1,
        "max_retries": 0,
        "timeout_ms": 300000
      },
      "session_strategy": "new_session",
      "stats": {
        "consecutive_failures": 0,
        "next_trigger_at": "2026-06-15T01:00:00Z",
        "total_failures": 0,
        "total_runs": 0
      }
    }
  },
  "name": "api-doc-verification-deployment",
  "paused_reason": null,
  "resources": [],
  "schedule": {
    "expression": "0 9 * * *",
    "timezone": "Asia/Shanghai",
    "type": "cron",
    "upcoming_runs_at": [
      "2026-06-15T01:00:00Z",
      "2026-06-16T01:00:00Z",
      "2026-06-17T01:00:00Z",
      "2026-06-18T01:00:00Z",
      "2026-06-19T01:00:00Z"
    ]
  },
  "status": "active",
  "type": "deployment",
  "updated_at": "2026-06-14T08:53:32Z",
  "vault_ids": []
}

​
レスポンスフィールド

フィールド型説明
idstringDeployment の一意識別子(dep_ プレフィックス)
typestring固定値 "deployment"
namestringDeployment 名
descriptionstring説明
agentobjectAgent 参照: {id, type, version}
environment_idstring関連付けられた Environment ID
scheduleobject or nullupcoming_runs_at を含むスケジュール設定(手動トリガーのみの場合は null)
schedule.expressionstringCron 式
schedule.timezonestringIANA タイムゾーン
schedule.typestring固定値 "cron"
schedule.upcoming_runs_atarray次の 5 回のスケジュール時刻(UTC、ISO 8601)
schedule.last_run_atstring最終実行時刻(初回実行後に出現)
initial_eventsarray各実行時に配信されるイベント
resourcesarray付加されたリソース
vault_idsarray関連付けられた Vault ID
metadataobject実行設定と統計を含む cas_config 入りメタデータ
statusstring"active" または "paused"
paused_reasonobject or null構造化された一時停止理由(例: {"type":"manual"})
archived_atstring or nullアーカイブタイムスタンプ(ISO 8601) または null
created_atstring作成時刻(ISO 8601)
updated_atstring最終更新時刻(ISO 8601)

​
CMA との整合

本エンドポイントは Anthropic CMA の POST /v1/deployments 仕様に整合しています。主な差分:
  • agent フィールドは文字列とオブジェクトの両形式を受け付けます(CMA はオブジェクトのみ)。
  • metadata.cas_config は実行チューニング用の CAS 拡張です(CMA 仕様には含まれません)。session_strategy、config(リトライ/タイムアウト/同時実行)、stats(実行回数/タイムスタンプ) を含みます。
  • レスポンスの schedule オブジェクトに upcoming_runs_at(最大 5 回の将来トリガー時刻) を含みます。

​
エラー

HTTPtype説明
400invalid_request_error必須フィールド欠落、無効な cron 式、未知のイベントタイプ、または参照先 Agent/Environment がアーカイブ済み
401authentication_errorPAT が無効または期限切れ
404not_found_errorAgent または Environment が存在しない
完全なエラーエンベロープについては エラー を参照してください。

​
関連項目

Deployment 一覧

アカウント配下のすべての Deployment をページ単位で取得します。

Deployment の更新

マージパッチで Deployment のフィールドを部分更新します。

Deployment の実行

手動トリガーで Deployment Run を即座に開始します。

エラー

共通のエラーエンベロープ仕様を参照します。