获取 /api/v1/projects/{id}/workspaces/{workspace_id}

按ID检索单个工作区。项目范围由路由 ID 路径参数承载。

路径参数

  • id 字符串 必需

    项目 ID

  • Workspace_id 字符串 必需

    工作区ID

响应

  • 不支持或格式不正确的API版本、所选已发布合约中不可用的操作或不可接受的表示形式(包括不支持的媒体类型参数或排除的 SSE)。现有的身份验证、授权和速率限制失败优先。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      标准错误模式定义的可选验证详细信息; API协商错误不会发出此字段。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        验证失败的字段。

        隐藏字段属性 显示字段属性 对象

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

          无效请求字段的名称或路径。

    • 详细信息 字符串 必需

      人类可读的错误详细信息。

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

      与错误相关的请求参数名称;不应用时省略。

    • 原因 字符串 必需

      HTTP状态原因短语。

    隐藏响应属性 显示响应属性 对象
    • badRequestDetail 对象

      标准错误模式定义的可选验证详细信息; API协商错误不会发出此字段。

      隐藏 BadRequestDetail 属性 显示 BadRequestDetail 属性 对象
      • 字段 大量[对象]

        验证失败的字段。

        隐藏字段属性 显示字段属性 对象

        字段及其验证失败。

        • 描述 字符串 必需

          人类可读的验证失败。

        • 字段 字符串 必需

          无效请求字段的名称或路径。

    • 详细信息 字符串 必需

      人类可读的错误详细信息。

    • 错误 整型 必需

      HTTP status code.

    • 错误代码 字符串 必需

      机器可读的错误代码。

    • 参数 array[string]

      与错误相关的请求参数名称;不应用时省略。

    • 原因 字符串 必需

      HTTP状态原因短语。

  • 200

    正常

    隐藏响应属性 显示响应属性 对象
    • aer_http_endpoint 字符串

      AERHTTPEndpoint 是代理沙箱HTTP端点的旧名称。

    • Agent_card 对象
      隐藏 Agent_card 属性 显示agent_card 属性 对象
      • a2a_allowed_callers array[string]

        2AAllowedCallers 限制哪些工作区 ID 可以通过 A2A 调用此代理。空列表表示允许任何调用者。

      • a2a_enabled 布尔

        A2AEnabled 控制此代理是否可供 A2A 调用发现。

      • 能力 array[string]
      • input_modes array[string]

        InputModes 列出代理接受的MIME类型(例如“text/plain”、 “应用程序/json”)。

      • output_modes array[string]

        OutputModes 列出了代理可以生成的MIME类型。

      • 技能 大量[对象]

        技能公布了代理可以执行的离散任务。

        隐藏技能属性 显示技能属性 对象
        • 描述 字符串
        • example_input 字符串
        • example_output 字符串
        • 名称 字符串
      • 总结 字符串
    • agent_grpc_endpoint 字符串
    • agent_http_endpoint 字符串

      AgentHTTPEndpoint 是代理沙箱HTTP端点。与 aer_http_endpoint 的值相同。

    • auto_deploy 布尔

      AutoDeploy 是 ECP 拥有的每应用自动部署开关。 ECP 所有,在每个详细信息 GET 时获取(不会持久保存在网关数据库中)。当 ECP 没有值或无法访问时不存在;用户界面界面将缺席视为关闭。

    • completed_rate 数字
    • created_date 字符串
    • current_deployment_id 字符串
    • current_payload_ref 字符串
    • 描述 字符串
    • 功能 对象
      隐藏要素属性 显示要素属性 对象
      • 护栏 布尔
      • 内存 布尔
      • 操场 布尔

        Playground 报告是否为工作区预配了 Playground用户界面(nil/true = 已预配,当前行为)。如果为 false,则调用者会直接使用调用API 。

      • use_custom_parser 布尔

        UseCustomParser 如果为 true,则使网关在调用流上仅发出代理的输出解析器自定义事件(删除平台框架)。从 AgentEngine 初始化时的代理.yaml 功能中保留。

    • 框架 字符串
    • github_installation_id 整型

      GithubInstallationID 是拥有该存储库的 GitHub 应用安装。 ECP 所有,在每个详细信息 GET 时获取(不会持久保存在网关数据库中),因此它适用于在此字段存在之前创建的工作区。在编辑跟踪的分支时,用户界面需要它来列出存储库的分支。

    • gitops 对象
      隐藏 gitops 属性 显示 gitops 属性 对象
      • 分支 字符串
      • connection_ref 字符串
      • github_installation_id integer(int64)
      • manifest_path 字符串
      • provider 字符串
      • repo_url 字符串
    • id 字符串
    • 实例 对象

      实例报告工作区的实例计数(活动、备用和正在启动)以及从工作区的 OE 单元获取的读取时间。当无法访问 OE 或工作区未以池化方式运行(例如容器模式),则不存在。故意没有任何内部实施命名:这是一个面向客户的字段。

      隐藏实例属性 显示实例属性 对象
      • 活跃的 整型
      • 池化 布尔
      • standby 整型
      • 开始 整型
    • 调用 整型

      滚动 24h窗口的执行指标。所有五个字段都是指针,因此连接线可以区分用户界面需要以不同方式呈现的两种情况:(a) OE指标获取失败(软故障 — 所有五个字段均不存在),或 (b)窗口包含零调用/没有已完成执行次数(调用次数设立为 0,且延迟/速率字段不存在)。用户界面区分“—”和从 "0 incalls"通过调用 != nil。

    • 语言 字符串
    • last_invoked_at string(date-time)
    • metrics_computed_at string(date-time)
    • metrics_window_start string(date-time)
    • 名称 字符串
    • org_id 字符串
    • p95_latency_ms 数字
    • PROJECT_ID 字符串
    • release_mode 字符串

      ReleaseMode 是 ECP 拥有的 Webhook发布策略 ("push" | "tag-release" | "api-only")。在每个详细信息 GET 上获取;当 ECP 没有值或无法访问时不存在。

    • 状态 字符串

      状态是 ECP 拥有的活动/暂停信号。网关在每次详细 GET 时从 ECP 获取 — 它不会在本地持久保存。当 ECP 无法访问时不存在;用户界面界面将缺席视为未暂停。

      取值为 active、paused、error、disconnected 或 deleting。

    • 子目录 字符串
    • updated_date 字符串
    • Workspace_id 字符串
    • Workspace_name 字符串
    隐藏响应属性 显示响应属性 对象
    • aer_http_endpoint 字符串

      AERHTTPEndpoint 是代理沙箱HTTP端点的旧名称。

    • Agent_card 对象
      隐藏 Agent_card 属性 显示agent_card 属性 对象
      • a2a_allowed_callers array[string]

        2AAllowedCallers 限制哪些工作区 ID 可以通过 A2A 调用此代理。空列表表示允许任何调用者。

      • a2a_enabled 布尔

        A2AEnabled 控制此代理是否可供 A2A 调用发现。

      • 能力 array[string]
      • input_modes array[string]

        InputModes 列出代理接受的MIME类型(例如“text/plain”、 “应用程序/json”)。

      • output_modes array[string]

        OutputModes 列出了代理可以生成的MIME类型。

      • 技能 大量[对象]

        技能公布了代理可以执行的离散任务。

        隐藏技能属性 显示技能属性 对象
        • 描述 字符串
        • example_input 字符串
        • example_output 字符串
        • 名称 字符串
      • 总结 字符串
    • agent_grpc_endpoint 字符串
    • agent_http_endpoint 字符串

      AgentHTTPEndpoint 是代理沙箱HTTP端点。与 aer_http_endpoint 的值相同。

    • auto_deploy 布尔

      AutoDeploy 是 ECP 拥有的每应用自动部署开关。 ECP 所有,在每个详细信息 GET 时获取(不会持久保存在网关数据库中)。当 ECP 没有值或无法访问时不存在;用户界面界面将缺席视为关闭。

    • completed_rate 数字
    • created_date 字符串
    • current_deployment_id 字符串
    • current_payload_ref 字符串
    • 描述 字符串
    • 功能 对象
      隐藏要素属性 显示要素属性 对象
      • 护栏 布尔
      • 内存 布尔
      • 操场 布尔

        Playground 报告是否为工作区预配了 Playground用户界面(nil/true = 已预配,当前行为)。如果为 false,则调用者会直接使用调用API 。

      • use_custom_parser 布尔

        UseCustomParser 如果为 true,则使网关在调用流上仅发出代理的输出解析器自定义事件(删除平台框架)。从 AgentEngine 初始化时的代理.yaml 功能中保留。

    • 框架 字符串
    • github_installation_id 整型

      GithubInstallationID 是拥有该存储库的 GitHub 应用安装。 ECP 所有,在每个详细信息 GET 时获取(不会持久保存在网关数据库中),因此它适用于在此字段存在之前创建的工作区。在编辑跟踪的分支时,用户界面需要它来列出存储库的分支。

    • gitops 对象
      隐藏 gitops 属性 显示 gitops 属性 对象
      • 分支 字符串
      • connection_ref 字符串
      • github_installation_id integer(int64)
      • manifest_path 字符串
      • provider 字符串
      • repo_url 字符串
    • id 字符串
    • 实例 对象

      实例报告工作区的实例计数(活动、备用和正在启动)以及从工作区的 OE 单元获取的读取时间。当无法访问 OE 或工作区未以池化方式运行(例如容器模式),则不存在。故意没有任何内部实施命名:这是一个面向客户的字段。

      隐藏实例属性 显示实例属性 对象
      • 活跃的 整型
      • 池化 布尔
      • standby 整型
      • 开始 整型
    • 调用 整型

      滚动 24h窗口的执行指标。所有五个字段都是指针,因此连接线可以区分用户界面需要以不同方式呈现的两种情况:(a) OE指标获取失败(软故障 — 所有五个字段均不存在),或 (b)窗口包含零调用/没有已完成执行次数(调用次数设立为 0,且延迟/速率字段不存在)。用户界面区分“—”和从 "0 incalls"通过调用 != nil。

    • 语言 字符串
    • last_invoked_at string(date-time)
    • metrics_computed_at string(date-time)
    • metrics_window_start string(date-time)
    • 名称 字符串
    • org_id 字符串
    • p95_latency_ms 数字
    • PROJECT_ID 字符串
    • release_mode 字符串

      ReleaseMode 是 ECP 拥有的 Webhook发布策略 ("push" | "tag-release" | "api-only")。在每个详细信息 GET 上获取;当 ECP 没有值或无法访问时不存在。

    • 状态 字符串

      状态是 ECP 拥有的活动/暂停信号。网关在每次详细 GET 时从 ECP 获取 — 它不会在本地持久保存。当 ECP 无法访问时不存在;用户界面界面将缺席视为未暂停。

      取值为 active、paused、error、disconnected 或 deleting。

    • 子目录 字符串
    • updated_date 字符串
    • Workspace_id 字符串
    • Workspace_name 字符串
  • Bad Request

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 未找到

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
  • 内部服务器错误

    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
    隐藏响应属性 显示响应属性 对象
    • 代码 字符串
    • 错误 字符串
    • Success 布尔
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
}