ワークスペースエージェントを呼び出し、その応答を返します。セッションを継続するには、前回の応答によって返された X-Session- ID値を送信します。ヘッダーを省略すると、ゲートウェイは新しいセッションを開始し、応答ヘッダーにそのIDを返します。 body Session_idフィールドはセッションを継続しません。ボディには追加の最上位フィールドを含めることができます。ゲートウェイは、メッセージ、セッション_id、user_id、および resume_map の予約フィールドを除くすべてのフィールドを転送します。 resume_map は中断された方向を続行します。履歴のないセッションの場合、 resume_map が最初のエージェント入力になります。有効な Bearer トークンが必要です。
ヘッダー
-
以前の応答によって返されたセッションID 。そのセッションを続行するには、 を送信します。有効な ID は [A-Za-z0 -9 _-],{1 128}$ と一致します。省略した場合、ゲートウェイは新しいセッションを開始します。 body Session_id はセッションを継続しません
-
新しく作成されたセッションをテスト セッションとして分類します。既存の分類は変更されていません
-
このブロッキング呼び出しのリクエストごとの待機予算(秒単位)(1-120)。省略した場合、配置の INVKE_WORKSPACE_TIMEOUT_SECONDS がデフォルトになります
最小値は
1、最大値は120です。
body
必須
リクエストのリクエスト
-
他のエージェントフィールドが提供されている場合は任意: チャット エージェントのチャット入力。予約されたフィールド名。
-
ResumeMap には UE によって解決された割り込みごとの応答が含まれています。 OA は、セッションの最初の実行を開始するときにのみ、それを通常の入力としてエージェントに転送します。ここでは、応答するローカルの一時停止タームが存在しません。
追加のプロパティが許可されます。
-
任意の互換性フィールド。ゲートウェイはセッション継続のためにそれを無視します。セッションを継続するには、代わりに X-Session- IDを送信します。予約されたフィールド名。
-
パーソナライズと メモリ分離に使用される任意の ID です。人間とAPIキーの呼び出しではこの値が使用されます。または、認証されたユーザーのデフォルトになります。サービス アカウント呼び出しでは、常にサービス アカウント ID が使用されます。サービス アカウントは、まだ別のユーザーとして機能できません。予約されたフィールド名。
応答
-
サポートされていないAPIバージョンまたは不正な API バージョン、選択した公開契約で利用できない操作、または受け入れができない表現(サポートされていないメディアタイプのパラメーター、または除外された SSE を含む)。既存の認証、認可、およびレート制限の失敗が優先されます。
-
OK
-
無効なリクエスト
-
許可されていない
-
競合
-
PROJECT_SECRET_INVALID:プロジェクトシークレットが無効またはアクセスできないため、ワークスペースを開始できません(シークレットを修正し再デプロイ)
-
リクエストが多すぎる
-
エージェントの独自の実行がエラーで解決されたときに Invite WorkspaceResponse を呼び出します( execution_id/status 付きの Success:false)。 Agentup_STARTUP_FAILED/STARTUP_FAILED のスタートアップ失敗の場合は StartupFailureResponse 。それ以外の場合は、ErrorResponse
-
POOL_EXHAUSTED/EXECUTOR_BOOT_FAILED/PLATform_DEPENDENT_FAILED/POOL_UNREACHABLE のスタートアップ失敗に対する StartupFailureResponseそれ以外の場合は、ErrorResponse POOL_EXHAUSTED は Retry-After ヘッダーを保持します
-
ゲートウェイ タイムアウト
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"
}
{
"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"
}
{
"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"
}
# 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"
}
# 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"
}
{
"code": "string",
"error": "string",
"success": true
}
{
"code": "string",
"error": "string",
"success": true
}
{
"code": "string",
"error": "string",
"success": true
}
{
"code": "string",
"error": "string",
"success": true
}
{
"blocking_execution_id": "string",
"blocking_status": "string",
"code": "string",
"error": "string",
"last_activity_at": "string"
}
{
"blocking_execution_id": "string",
"blocking_status": "string",
"code": "string",
"error": "string",
"last_activity_at": "string"
}
{
"code": "string",
"error": "string",
"success": true
}
{
"code": "string",
"error": "string",
"success": true
}
# Headers
Retry-After: string
# Payload
{
"code": "string",
"error": "string",
"success": true
}
# Headers
Retry-After: string
# Payload
{
"code": "string",
"error": "string",
"success": true
}
{
"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
}
{
"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
}
# 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
}
# 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
}
{
"code": "string",
"error": "string",
"success": true
}
{
"code": "string",
"error": "string",
"success": true
}