OpenAI 列出智能体环境文件

2026-11-18 17:53 更新

get /agents/environments/{environment_id}/files

列出已连接执行环境中当前存在的文件。可按目录筛选,使用由服务端生成的不透明游标分页。参见环境文件。

路径参数

  • environment_id: string

环境 ID。

minLength: 0, maxLength: 1048576

查询参数

  • limit: optional integer or null

每次最多返回的文件数,范围为 1 至 100。

format: int64, minimum: 1, maximum: 100

  • order: optional "asc" or "desc"

按路径各组成部分排序,区分大小写。默认降序。

  • "asc"

按升序返回资源。

  • "desc"

按降序返回资源。

  • page: optional string

上一页返回的不透明游标。翻页时保持路径、排序方式和数量上限一致。

minLength: 0, maxLength: 1048576

  • path: optional string or null

仅列出此工作区绝对路径下的文件。

minLength: 0, maxLength: 1048576

返回值

  • data: array of EnvironmentFile

当前页的文件。

minItems: 0, maxItems: 2000

  • environment_id: string

存放此文件的环境 ID。

minLength: 0

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

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

  • "agent.environment.file"

  • path: string

环境工作区内文件的绝对路径。

minLength: 0

  • size_bytes: integer

文件大小,单位为字节。

format: int64, minimum: 0

  • has_more: boolean

此页之后是否还有文件。

  • next: string or null

用于请求下一页的不透明游标(如有)。

minLength: 0

  • object: "page" (default: "page")

对象类型,固定为 page。

  • "page"

示例

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

200 响应示例

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

{
  "data": [
    {
      "environment_id": "environment_id",
      "object": "agent.environment.file",
      "path": "path",
      "size_bytes": 0
    }
  ],
  "has_more": true,
  "next": "next",
  "object": "page"
}

需要添加文件时,可调用写入智能体环境文件。

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号