PATCH /api/v1/projects/{id}/workspaces/{workspace_id}

ワークスペースを部分的に更新します。プロジェクトスコープは、ルート ID パス パラメーターによって保持されます。フィールドのみのパッチは 204 を返します。ステータス専用パッチ(一時停止/再開)は他のフィールドと排他的であり、ECP のアプリ本体(任意の warnings を含む)とともに 200 を返します。

path パラメータ

  • id string 必須

    プロジェクトID

  • Workspace_id string 必須

    ワークスペースID

application/ JSON

body 必須

更新するフィールド

  • Agent_card オブジェクト
    Agent_card 属性を非表示 Agent_card 属性の表示 オブジェクト
    • a2a_allowed_shellers array[string]

      A2AAllowedCoders は、A2A 経由でこのエージェントを呼び出せるワークスペース ID を制限します。空のリストは、すべての呼び出し元が許可されることを意味します。

    • a2a_enabled ブール値

      A2AEnabled は、このエージェントが A2A 呼び出しで検出可能かどうかを制御します。

    • 機能 array[string]
    • input_modes array[string]

      inputModes は、エージェントが受け入れるMIMEタイプを一覧表示します(例: "text/lain"、" アプリケーション/json")。

    • output_modes array[string]

      outputModes では、エージェントが生成できるMIMEタイプが一覧表示されます。

    • スキル array[オブジェクト]

      特権は、エージェントが実行できる個別のタスクを紹介します。

      スキー属性を非表示にする スキー属性を表示する オブジェクト
      • 説明 string
      • sample_in input string
      • sample_ output string
      • name string
    • 概要 string
  • auto_deploy ブール値

    AutoDeploy は、アプリレベルの ECPフィールド(ゲートウェイ DB に永続化されていない)です。は ECPアプリPATCH に冗長性を転送しました。

  • 説明 string
  • 機能 オブジェクト
    機能属性を非表示にする 機能属性の表示 オブジェクト
    • ガードレール ブール値
    • メモリ ブール値
    • 遊び場 ブール値

      Playground は、プレイグラウンドUIがワークスペースにプロビジョニングされているかどうかを報告します(nil/true = 現在の動作)。 false の場合、呼び出し元は呼び出しAPI を直接使用します。

    • use_custom_parser ブール値

      UseCustomParser が true の場合、Gateway は呼び出しストリーム(プラットフォーム フレームの削除)上のエージェントの出力パーサー カスタム イベントのみを発行します。エージェントエンジン初期化時にエージェント.YAML 機能によって永続化されます。

  • フレームワーク string
  • gitops オブジェクト
    Gitps 属性を非表示にする Gitps 属性の表示 オブジェクト
    • branch string
    • connection_ref string
    • マニフェスト_パス string
    • プロバイダー string
    • repo_url string
  • name string
  • Release_mode string

    ReleaseMode は、アプリレベルの ECPフィールド(ゲートウェイ DB には保持されていない)です。は ECPアプリPATCH に冗長性を転送しました。 Webhook トリガーされたビルドのみを制御します - APIトリガーされたリリースはすべてのモードで利用可能です。

  • 状態 string

    ステータスは一時停止/再開シグナル("active"||"一時停止") です。ゲートウェイはローカルに保持しません。ハンドラーはステータスのみのパッチを ECP に直接転送し、一時停止の引き継ぎ/再開の再配置を実行します。

  • サブディレクトリ string
  • Workspace_name string

応答

  • サポートされていないAPIバージョンまたは不正な API バージョン、選択した公開契約で利用できない操作、または受け入れができない表現(サポートされていないメディアタイプのパラメーター、または除外された SSE を含む)。既存の認証、認可、およびレート制限の失敗が優先されます。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。

    応答属性の非表示 応答属性の表示 オブジェクト
    • validRequestDetail オブジェクト

      標準エラースキーマによって定義される任意の検証の詳細。 APIネゴシエート エラーでは、このフィールドは出力されません。

      validRequestDetail 属性を非表示にする validRequestDetail 属性の表示 オブジェクト
      • フィールド array[オブジェクト]

        検証に失敗したフィールド。

        フィールド属性を非表示にする フィールド属性の表示 オブジェクト

        フィールドとその検証の失敗。

        • 説明 string 必須

          人間が判読できる検証の失敗。

        • フィールド string 必須

          無効なリクエストフィールドの名前またはパス。

    • 詳細 string 必須

      人間が判読できるエラーの詳細。

    • エラー integer 必須

      HTTP status code.

    • errorCode string 必須

      マシンが判読できるエラー コード。

    • パラメーター array[string]

      エラーに関連付けられたリクエスト パラメータ名。該当しない場合は省略します。

    • 理由 string 必須

      HTTPステータス理由フレーズ。

  • 200

    ステータスのみのパッチの場合に返されます。 ECP からプロキシされた

    応答属性の非表示 応答属性の表示 オブジェクト
    • app_id string
    • org_id string
    • project_id string
    • 状態 string
    • 警告 array[string]
    応答属性の非表示 応答属性の表示 オブジェクト
    • app_id string
    • org_id string
    • project_id string
    • 状態 string
    • 警告 array[string]
  • 204

    フィールド アップデート パッチの場合に返されます。

  • 無効なリクエスト

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 見つかりません

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • エンティティが大きすぎるリクエスト

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 429

    リクエストが多すぎる

    ヘッダー属性を非表示 ヘッダー属性を表示
    • 再試行後 string

      再試行する前に待機する秒数

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 内部サーバーエラー

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 502

    ECP トランスポートまたは一時停止シャットダウンの障害。

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 503

    サービスは利用できません

    ヘッダー属性を非表示 ヘッダー属性を表示
    • 再試行後 string

      再試行する前に待機する秒数

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
PATCH /api/v1 /projects/{id}/workspaces/{workspace_id}
curl \
 --request PATCH 'https://agentengine.mongodb.com/api/v1/projects/{id}/workspaces/{workspace_id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "agent_card": {
    "a2a_allowed_callers": [
      "string"
    ],
    "a2a_enabled": true,
    "capabilities": [
      "string"
    ],
    "input_modes": [
      "string"
    ],
    "output_modes": [
      "string"
    ],
    "skills": [
      {
        "description": "string",
        "example_input": "string",
        "example_output": "string",
        "name": "string"
      }
    ],
    "summary": "string"
  },
  "auto_deploy": true,
  "description": "string",
  "features": {
    "guardrails": true,
    "memory": true,
    "playground": true,
    "use_custom_parser": true
  },
  "framework": "string",
  "gitops": {
    "branch": "string",
    "connection_ref": "string",
    "manifest_path": "string",
    "provider": "string",
    "repo_url": "string"
  },
  "name": "string",
  "release_mode": "string",
  "status": "string",
  "subdirectory": "string",
  "workspace_name": "string"
}'
リクエスト例
{
  "agent_card": {
    "a2a_allowed_callers": [
      "string"
    ],
    "a2a_enabled": true,
    "capabilities": [
      "string"
    ],
    "input_modes": [
      "string"
    ],
    "output_modes": [
      "string"
    ],
    "skills": [
      {
        "description": "string",
        "example_input": "string",
        "example_output": "string",
        "name": "string"
      }
    ],
    "summary": "string"
  },
  "auto_deploy": true,
  "description": "string",
  "features": {
    "guardrails": true,
    "memory": true,
    "playground": true,
    "use_custom_parser": true
  },
  "framework": "string",
  "gitops": {
    "branch": "string",
    "connection_ref": "string",
    "manifest_path": "string",
    "provider": "string",
    "repo_url": "string"
  },
  "name": "string",
  "release_mode": "string",
  "status": "string",
  "subdirectory": "string",
  "workspace_name": "string"
}
応答の例(406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例(406)
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
応答の例(200)
{
  "app_id": "string",
  "org_id": "string",
  "project_id": "string",
  "status": "active",
  "warnings": [
    "string"
  ]
}
応答の例(200)
{
  "app_id": "string",
  "org_id": "string",
  "project_id": "string",
  "status": "active",
  "warnings": [
    "string"
  ]
}
応答の例(400)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(400)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(404)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(404)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(413)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(413)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(429)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(429)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(500)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(500)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(502)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(502)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(503)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(503)
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}