OpenAI 获取智能体环境

2026-11-18 17:53 更新

get /agents/environments/{environment_id}

获取执行环境的连接状态及可返回的已安装资源元数据。参见环境生命周期。

路径参数

  • environment_id: string

环境 ID。

minLength: 0, maxLength: 1048576

返回值

  • EnvironmentInfo object { id, files, object, 4 more }

可返回的独立执行环境资源的元数据。

  • id: string

环境 ID。

minLength: 0

  • files: array of HostedEnvironmentFile

环境中已安装的文件。响应省略文件内容。

minItems: 0, maxItems: 2000

  • HostedEnvironmentFileID object { id, file_id, path, 2 more }

从 OpenAI Files API 复制的文件。

  • id: string

执行环境中会话范围内的文件 ID。

minLength: 0

  • file_id: string

已上传文件的 ID。

minLength: 0

  • path: string

文件在环境内的绝对路径。

minLength: 0

  • size_bytes: integer

文件解码后的大小,单位为字节。

format: int64, minimum: 0

  • type: "file_id" (default: "file_id")

对象类型,固定为 file_id。

  • "file_id"

  • Inline object { id, path, size_bytes, type }

创建会话时以内联方式提供的文件。

  • id: string

执行环境中会话范围内的文件 ID。

minLength: 0

  • path: string

文件在环境内的绝对路径。

minLength: 0

  • size_bytes: integer

文件解码后的大小,单位为字节。

format: int64, minimum: 0

  • type: "inline" (default: "inline")

对象类型,固定为 inline。

  • "inline"

  • object: "agent.environment" (default: "agent.environment")

对象类型,固定为 agent.environment。

  • "agent.environment"

  • plugins: array of HostedPlugin

环境中已安装的插件。响应省略归档内容。

minItems: 0, maxItems: 2000

  • description: string

已安装插件的描述。

minLength: 0

  • name: string

已安装插件的名称。

minLength: 0

  • type: "inline" (default: "inline")

对象类型,固定为 inline。

  • "inline"

  • skills: array of HostedSkill

环境中已安装的技能。响应省略归档内容。

minItems: 0, maxItems: 2000

  • HostedSkillReference object { description, name, skill_id, 2 more }

从 Skills API 安装的技能。

  • description: string

已安装技能的描述。

minLength: 0

  • name: string

已安装技能的名称。

minLength: 0

  • skill_id: string

引用的技能 ID。

minLength: 0

  • type: "skill_reference" (default: "skill_reference")

对象类型,固定为 skill_reference。

  • "skill_reference"

  • version: string

此会话实际安装的技能版本。

minLength: 0

  • Inline object { description, name, type }

从内联 ZIP 归档安装的技能。

  • description: string

已安装技能的描述。

minLength: 0

  • name: string

已安装技能的名称。

minLength: 0

  • type: "inline" (default: "inline")

对象类型,固定为 inline。

  • "inline"

  • status: "pending" or "ready" or "connected" or 4 more

环境当前的连接状态。

  • "pending"

  • "ready"

环境已成功配置,可附加到会话或投入使用。

  • "connected"

  • "disconnected"

  • "suspended"

沙箱已停止,可从其私有检查点恢复。

  • "expired"

  • "failed"

  • type: "openai_hosted" or "self_hosted"

环境由 OpenAI 还是由应用托管。

  • "openai_hosted"

  • "self_hosted"

示例

## 从环境变量读取 API 密钥。
## 将 ENVIRONMENT_ID 设置为目标环境的 ID。
curl https://api.openai.com/v1/agents/environments/$ENVIRONMENT_ID \
    -H 'OpenAI-Beta: agents=v1' \
    -H "Authorization: Bearer $OPENAI_API_KEY"

200 响应示例

字段名、类型值和示例标识均按接口定义保留。

{
  "id": "id",
  "files": [
    {
      "id": "id",
      "file_id": "file_id",
      "path": "path",
      "size_bytes": 0,
      "type": "file_id"
    }
  ],
  "object": "agent.environment",
  "plugins": [
    {
      "description": "description",
      "name": "name",
      "type": "inline"
    }
  ],
  "skills": [
    {
      "description": "description",
      "name": "name",
      "skill_id": "skill_id",
      "type": "skill_reference",
      "version": "version"
    }
  ],
  "status": "pending",
  "type": "openai_hosted"
}
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号