ワークスペースを取得する

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

Bearer 認証

IDで単一のワークスペースを検索します。プロジェクトスコープは、ルート ID パスパラメーターによって保持されます。

path パラメータ

id string 必須

プロジェクトID
Workspace_id string 必須

ワークスペースID

応答

406

application/ JSON

application/ JSON アプリケーション/vnd.agent- engine-2026-09-20-preview+json

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

アプリケーション/vnd.agent- engine-2026-09-20-preview+json

アプリケーション/vnd.agent- engine-2026-09-20-preview+json application/ JSON

OK
応答属性の非表示応答属性の表示オブジェクト
- aer_http_endpoint string
  
  AERHTTPEndpoint は、エージェントサンドボックスHTTPエンドポイントのレガシー名です。
- 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
- agent_grpc_endpoint string
- agent_http_endpoint string
  
  AgentHTTPEndpoint は、エージェントサンドボックスHTTPエンドポイントです。 aer_HTTP_endpoint と同じ値。
- auto_deploy ブール値
  
  AutoDeploy は、ECP が所有するアプリごとの自動配置のトグルです。 ECP が所有し、各詳細 GET で取得されます（ゲートウェイ DB には保持されません）。 ECP 値が存在しないか、到達不能な場合は存在しません。 UI は存在しないをオフとして扱います。
- completed_rate 数値
- created_date string
- current_deployment_id string
- current_ payload_ref string
- 説明 string
- 機能オブジェクト
  
  機能属性を非表示にする機能属性の表示オブジェクト
  
  ガードレールブール値
  
  メモリブール値
  
  遊び場ブール値
  
  Playground は、プレイグラウンドUIがワークスペースにプロビジョニングされているかどうかを報告します（nil/true = 現在の動作）。 false の場合、呼び出し元は呼び出しAPI を直接使用します。
  
  use_custom_parser ブール値
  
  UseCustomParser が true の場合、Gateway は呼び出しストリーム（プラットフォームフレームの削除）上のエージェントの出力パーサーカスタムイベントのみを発行します。エージェントエンジン初期化時にエージェント.YAML 機能によって永続化されます。
- フレームワーク string
- github_インストール_id integer
  
  Githubインストール ID は、リポジトリを所有する Github アプリのインストールです。 ECP が所有し、各詳細 GET で取得されるため（ゲートウェイ DB には保持されない）、このフィールドが存在する前に作成されたワークスペースでは機能します。 UI は、追跡ブランチを編集するときにリポジトリのブランチを一覧表示するためにこのパラメーターが必要です。
- gitops オブジェクト
  
  Gitps 属性を非表示にする Gitps 属性の表示オブジェクト
  
  branch string
  
  connection_ref string
  
  github_インストール_id integer(int64)
  
  マニフェスト_パス string
  
  プロバイダー string
  
  repo_url string
- id string
- インスタンスオブジェクト
  
  インスタンスは、ワークスペースのインスタンスセルから取得された読み取り時間（アクティブ、スタンバイ、起動中）を報告します。 OU に到達できない場合、またはワークスペースでプールが実行されない場合は中止されます（例:コンテナモード）。内部実装の名前付けは一切含まれません。これはカスタマー向けフィールドです。
  
  インスタンス属性の非表示インスタンス属性を表示するオブジェクト
  
  アクティブ integer
  
  プールされましたブール値
  
  standby integer
  
  起動 integer
- 呼び出し integer
  
  ローリング 24hウィンドウにわたる実行メトリクス。 5つのフィールドはすべてポインターであるため、ワイヤはUIが異なる方法でレンダリングする必要がある 2 つのケースを区別できます。(a) OA メトリクスの取得に失敗した（ソフトフェイル、5 つのフィールドがすべて存在しない）場合、または (b)ウィンドウに含まれる呼び出しがゼロか、完了がありませんの実行（呼び出しが 0 に設定されており、レイテンシやレートフィールドが存在しない場合） UI は"q" とを区別します。「0 呼び出し」からのによる呼び出し != nil。
- 言語 string
- last_invoice_at string(date-time)
- metrics_computed_at string(date-time)
- metrics_ window_start string(date-time)
- name string
- org_id string
- p95_latency_ms 数値
- project_id string
- Release_mode string
  
  ReleaseMode は、ECP が所有する Webhook リリースポリシー（"push""||"Tag- Release"||"api-only"）。各詳細 GET で取得されます。 ECP に値がないか、到達不能な場合は存在しません。
- 状態 string
  
  ステータスは、ECP が所有するアクティブまたは一時停止されたシグナルです。ゲートウェイは、各詳細 GET の ECP からそれを取得しますが、ローカルでは永続化されません。 ECP に到達できない場合は存在しません。 UI は存在しないを一時停止されていないものとして扱います。
  
  値は、active、paused、error、disconnected、または deleting です。
- サブディレクトリ string
- updated_date string
- Workspace_id string
- Workspace_name string
応答属性の非表示応答属性の表示オブジェクト
- aer_http_endpoint string
  
  AERHTTPEndpoint は、エージェントサンドボックスHTTPエンドポイントのレガシー名です。
- 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
- agent_grpc_endpoint string
- agent_http_endpoint string
  
  AgentHTTPEndpoint は、エージェントサンドボックスHTTPエンドポイントです。 aer_HTTP_endpoint と同じ値。
- auto_deploy ブール値
  
  AutoDeploy は、ECP が所有するアプリごとの自動配置のトグルです。 ECP が所有し、各詳細 GET で取得されます（ゲートウェイ DB には保持されません）。 ECP 値が存在しないか、到達不能な場合は存在しません。 UI は存在しないをオフとして扱います。
- completed_rate 数値
- created_date string
- current_deployment_id string
- current_ payload_ref string
- 説明 string
- 機能オブジェクト
  
  機能属性を非表示にする機能属性の表示オブジェクト
  
  ガードレールブール値
  
  メモリブール値
  
  遊び場ブール値
  
  Playground は、プレイグラウンドUIがワークスペースにプロビジョニングされているかどうかを報告します（nil/true = 現在の動作）。 false の場合、呼び出し元は呼び出しAPI を直接使用します。
  
  use_custom_parser ブール値
  
  UseCustomParser が true の場合、Gateway は呼び出しストリーム（プラットフォームフレームの削除）上のエージェントの出力パーサーカスタムイベントのみを発行します。エージェントエンジン初期化時にエージェント.YAML 機能によって永続化されます。
- フレームワーク string
- github_インストール_id integer
  
  Githubインストール ID は、リポジトリを所有する Github アプリのインストールです。 ECP が所有し、各詳細 GET で取得されるため（ゲートウェイ DB には保持されない）、このフィールドが存在する前に作成されたワークスペースでは機能します。 UI は、追跡ブランチを編集するときにリポジトリのブランチを一覧表示するためにこのパラメーターが必要です。
- gitops オブジェクト
  
  Gitps 属性を非表示にする Gitps 属性の表示オブジェクト
  
  branch string
  
  connection_ref string
  
  github_インストール_id integer(int64)
  
  マニフェスト_パス string
  
  プロバイダー string
  
  repo_url string
- id string
- インスタンスオブジェクト
  
  インスタンスは、ワークスペースのインスタンスセルから取得された読み取り時間（アクティブ、スタンバイ、起動中）を報告します。 OU に到達できない場合、またはワークスペースでプールが実行されない場合は中止されます（例:コンテナモード）。内部実装の名前付けは一切含まれません。これはカスタマー向けフィールドです。
  
  インスタンス属性の非表示インスタンス属性を表示するオブジェクト
  
  アクティブ integer
  
  プールされましたブール値
  
  standby integer
  
  起動 integer
- 呼び出し integer
  
  ローリング 24hウィンドウにわたる実行メトリクス。 5つのフィールドはすべてポインターであるため、ワイヤはUIが異なる方法でレンダリングする必要がある 2 つのケースを区別できます。(a) OA メトリクスの取得に失敗した（ソフトフェイル、5 つのフィールドがすべて存在しない）場合、または (b)ウィンドウに含まれる呼び出しがゼロか、完了がありませんの実行（呼び出しが 0 に設定されており、レイテンシやレートフィールドが存在しない場合） UI は"q" とを区別します。「0 呼び出し」からのによる呼び出し != nil。
- 言語 string
- last_invoice_at string(date-time)
- metrics_computed_at string(date-time)
- metrics_ window_start string(date-time)
- name string
- org_id string
- p95_latency_ms 数値
- project_id string
- Release_mode string
  
  ReleaseMode は、ECP が所有する Webhook リリースポリシー（"push""||"Tag- Release"||"api-only"）。各詳細 GET で取得されます。 ECP に値がないか、到達不能な場合は存在しません。
- 状態 string
  
  ステータスは、ECP が所有するアクティブまたは一時停止されたシグナルです。ゲートウェイは、各詳細 GET の ECP からそれを取得しますが、ローカルでは永続化されません。 ECP に到達できない場合は存在しません。 UI は存在しないを一時停止されていないものとして扱います。
  
  値は、active、paused、error、disconnected、または deleting です。
- サブディレクトリ string
- updated_date string
- Workspace_id string
- Workspace_name string
400

application/ JSON

application/ JSON アプリケーション/vnd.agent- engine-2026-09-20-preview+json

無効なリクエスト
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値
応答属性の非表示応答属性の表示オブジェクト
- コード string
- エラー string
- 成功ブール値
404

application/ JSON

application/ JSON アプリケーション/vnd.agent- engine-2026-09-20-preview+json

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

application/ JSON

application/ JSON アプリケーション/vnd.agent- engine-2026-09-20-preview+json

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

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

curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/projects/{id}/workspaces/{workspace_id}' \
 --header "Authorization: $API_KEY"

応答の例（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）

{
  "aer_http_endpoint": "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"
  },
  "agent_grpc_endpoint": "string",
  "agent_http_endpoint": "string",
  "auto_deploy": true,
  "completion_rate": 42.0,
  "created_date": "string",
  "current_deployment_id": "string",
  "current_payload_ref": "string",
  "description": "string",
  "features": {
    "guardrails": true,
    "memory": true,
    "playground": true,
    "use_custom_parser": true
  },
  "framework": "string",
  "github_installation_id": 42,
  "gitops": {
    "branch": "string",
    "connection_ref": "string",
    "github_installation_id": 42,
    "manifest_path": "string",
    "provider": "string",
    "repo_url": "string"
  },
  "id": "string",
  "instances": {
    "active": 42,
    "pooled": true,
    "standby": 42,
    "starting": 42
  },
  "invocations": 42,
  "language": "string",
  "last_invoked_at": "2026-05-04T09:42:00Z",
  "metrics_computed_at": "2026-05-04T09:42:00Z",
  "metrics_window_start": "2026-05-04T09:42:00Z",
  "name": "string",
  "org_id": "string",
  "p95_latency_ms": 42.0,
  "project_id": "string",
  "release_mode": "string",
  "status": "active",
  "subdirectory": "string",
  "updated_date": "string",
  "workspace_id": "string",
  "workspace_name": "string"
}

応答の例（200）

{
  "aer_http_endpoint": "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"
  },
  "agent_grpc_endpoint": "string",
  "agent_http_endpoint": "string",
  "auto_deploy": true,
  "completion_rate": 42.0,
  "created_date": "string",
  "current_deployment_id": "string",
  "current_payload_ref": "string",
  "description": "string",
  "features": {
    "guardrails": true,
    "memory": true,
    "playground": true,
    "use_custom_parser": true
  },
  "framework": "string",
  "github_installation_id": 42,
  "gitops": {
    "branch": "string",
    "connection_ref": "string",
    "github_installation_id": 42,
    "manifest_path": "string",
    "provider": "string",
    "repo_url": "string"
  },
  "id": "string",
  "instances": {
    "active": 42,
    "pooled": true,
    "standby": 42,
    "starting": 42
  },
  "invocations": 42,
  "language": "string",
  "last_invoked_at": "2026-05-04T09:42:00Z",
  "metrics_computed_at": "2026-05-04T09:42:00Z",
  "metrics_window_start": "2026-05-04T09:42:00Z",
  "name": "string",
  "org_id": "string",
  "p95_latency_ms": 42.0,
  "project_id": "string",
  "release_mode": "string",
  "status": "active",
  "subdirectory": "string",
  "updated_date": "string",
  "workspace_id": "string",
  "workspace_name": "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
}

応答の例（500）

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

応答の例（500）

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