POST /api/v1/projects/{id}/workspaces/{workspace_id}/invoke

ワークスペースエージェントを呼び出し、その応答を返します。セッションを継続するには、前回の応答によって返された X-Session- ID値を送信します。ヘッダーを省略すると、ゲートウェイは新しいセッションを開始し、応答ヘッダーにそのIDを返します。 body Session_idフィールドはセッションを継続しません。ボディには追加の最上位フィールドを含めることができます。ゲートウェイは、メッセージ、セッション_id、user_id、および resume_map の予約フィールドを除くすべてのフィールドを転送します。 resume_map は中断された方向を続行します。履歴のないセッションの場合、 resume_map が最初のエージェント入力になります。有効な Bearer トークンが必要です。

ヘッダー

  • X-Session- ID string

    以前の応答によって返されたセッションID 。そのセッションを続行するには、 を送信します。有効な ID は [A-Za-z0 -9 _-],{1 128}$ と一致します。省略した場合、ゲートウェイは新しいセッションを開始します。 body Session_id はセッションを継続しません

  • X-エージェント-エンジン テスト-セッション ブール値

    新しく作成されたセッションをテスト セッションとして分類します。既存の分類は変更されていません

  • X-エージェント-エンジン呼び出しタイムアウト-秒 integer

    このブロッキング呼び出しのリクエストごとの待機予算(秒単位)(1-120)。省略した場合、配置の INVKE_WORKSPACE_TIMEOUT_SECONDS がデフォルトになります

    最小値は 1、最大値は 120 です。

path パラメータ

  • id string 必須

    プロジェクトID

  • Workspace_id string 必須

    ワークスペースID

application/ JSON

body 必須

リクエストのリクエスト

  • メッセージ string

    他のエージェントフィールドが提供されている場合は任意: チャット エージェントのチャット入力。予約されたフィールド名。

  • resume_map オブジェクト

    ResumeMap には UE によって解決された割り込みごとの応答が含まれています。 OA は、セッションの最初の実行を開始するときにのみ、それを通常の入力としてエージェントに転送します。ここでは、応答するローカルの一時停止タームが存在しません。

    追加のプロパティが許可されます。

  • Session_id string

    任意の互換性フィールド。ゲートウェイはセッション継続のためにそれを無視します。セッションを継続するには、代わりに X-Session- IDを送信します。予約されたフィールド名。

  • user_id string

    パーソナライズと メモリ分離に使用される任意の ID です。人間とAPIキーの呼び出しではこの値が使用されます。または、認証されたユーザーのデフォルトになります。サービス アカウント呼び出しでは、常にサービス アカウント ID が使用されます。サービス アカウントは、まだ別のユーザーとして機能できません。予約されたフィールド名。

応答

  • サポートされていない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

    OK

    ヘッダー属性を非表示 ヘッダー属性を表示
    • X-Session- ID string

      [A-Za-z0 -9 _-],{1 128}$ に一致するセッションID 。セッションを続行するには、次のリクエストでこの値を送信します

    応答属性の非表示 応答属性の表示 オブジェクト
    • エラー string
    • error_code string
    • execution_id string
    • 応答 string
    • 状態 string
    • 成功 ブール値
    • pause_context オブジェクト

      追加のプロパティが許可されます。

    • paused_理由 string
    応答属性の非表示 応答属性の表示 オブジェクト
    • エラー string
    • error_code string
    • execution_id string
    • 応答 string
    • 状態 string
    • 成功 ブール値
    • pause_context オブジェクト

      追加のプロパティが許可されます。

    • paused_理由 string
  • 無効なリクエスト

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
  • 許可されていない

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

    競合

    応答属性の非表示 応答属性の表示 オブジェクト
    • mapping_execution_id string
    • ブロッキング_ステータス string
    • コード string
    • エラー string
    • last_active_at string
    応答属性の非表示 応答属性の表示 オブジェクト
    • mapping_execution_id string
    • ブロッキング_ステータス string
    • コード string
    • エラー string
    • last_active_at string
  • 422

    PROJECT_SECRET_INVALID:プロジェクトシークレットが無効またはアクセスできないため、ワークスペースを開始できません(シークレットを修正し再デプロイ)

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

    リクエストが多すぎる

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

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

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

    エージェントの独自の実行がエラーで解決されたときに Invite WorkspaceResponse を呼び出します( execution_id/status 付きの Success:false)。 Agentup_STARTUP_FAILED/STARTUP_FAILED のスタートアップ失敗の場合は StartupFailureResponse 。それ以外の場合は、ErrorResponse

    次のいずれか:
    次のいずれか:
  • 503

    POOL_EXHAUSTED/EXECUTOR_BOOT_FAILED/PLATform_DEPENDENT_FAILED/POOL_UNREACHABLE のスタートアップ失敗に対する StartupFailureResponseそれ以外の場合は、ErrorResponse POOL_EXHAUSTED は Retry-After ヘッダーを保持します

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

      再試行する前に待機する秒数(POOL_EXHAUSTED のみ)

    次のいずれか:
    次のいずれか:
  • ゲートウェイ タイムアウト

    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
    応答属性の非表示 応答属性の表示 オブジェクト
    • コード string
    • エラー string
    • 成功 ブール値
POST /api/v1 /projects/{id}/workspaces/{workspace_id}/invoice
curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/projects/{id}/workspaces/{workspace_id}/invoke' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "X-Session-ID: string" \
 --header "X-Agent-Engine-Test-Session: true" \
 --header "X-Agent-Engine-Invoke-Timeout-Seconds: 42" \
 --data '{
  "message": "string",
  "resume_map": {},
  "session_id": "string",
  "user_id": "string"
}'
リクエスト例
# Headers
X-Session-ID: string
X-Agent-Engine-Test-Session: true
X-Agent-Engine-Invoke-Timeout-Seconds: 42

# Payload
{
  "message": "string",
  "resume_map": {},
  "session_id": "string",
  "user_id": "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)
# Headers
X-Session-ID: string

# Payload
{
  "error": "string",
  "error_code": "string",
  "execution_id": "string",
  "response": "string",
  "status": "string",
  "success": true,
  "suspend_context": {},
  "suspend_reason": "string"
}
応答の例(200)
# Headers
X-Session-ID: string

# Payload
{
  "error": "string",
  "error_code": "string",
  "execution_id": "string",
  "response": "string",
  "status": "string",
  "success": true,
  "suspend_context": {},
  "suspend_reason": "string"
}
応答の例(400)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(400)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(401)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(401)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(409)
{
  "blocking_execution_id": "string",
  "blocking_status": "string",
  "code": "string",
  "error": "string",
  "last_activity_at": "string"
}
応答の例(409)
{
  "blocking_execution_id": "string",
  "blocking_status": "string",
  "code": "string",
  "error": "string",
  "last_activity_at": "string"
}
応答の例(422)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(422)
{
  "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)
{
  "error": "string",
  "error_code": "string",
  "execution_id": "string",
  "response": "string",
  "status": "string",
  "success": true,
  "suspend_context": {},
  "suspend_reason": "string"
}
{
  "boot_id": "string",
  "code": "string",
  "component": "string",
  "error": "string",
  "execution_id": "string",
  "sandbox": "string",
  "source": "string",
  "success": true
}
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(500)
{
  "error": "string",
  "error_code": "string",
  "execution_id": "string",
  "response": "string",
  "status": "string",
  "success": true,
  "suspend_context": {},
  "suspend_reason": "string"
}
{
  "boot_id": "string",
  "code": "string",
  "component": "string",
  "error": "string",
  "execution_id": "string",
  "sandbox": "string",
  "source": "string",
  "success": true
}
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(503)
# Headers
Retry-After: string

# Payload
{
  "boot_id": "string",
  "code": "string",
  "component": "string",
  "error": "string",
  "execution_id": "string",
  "sandbox": "string",
  "source": "string",
  "success": true
}
# Headers
Retry-After: string

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

# Payload
{
  "boot_id": "string",
  "code": "string",
  "component": "string",
  "error": "string",
  "execution_id": "string",
  "sandbox": "string",
  "source": "string",
  "success": true
}
# Headers
Retry-After: string

# Payload
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(504)
{
  "code": "string",
  "error": "string",
  "success": true
}
応答の例(504)
{
  "code": "string",
  "error": "string",
  "success": true
}