OpenAI 列出凭证库

2026-11-18 18:02 更新

get /vaults

使用基于 ID 的分页列出凭证库。参见凭证库指南。

查询参数

  • after: optional string

按选定顺序返回此资源 ID 之后的资源。

minLength: 0, maxLength: 1048576

  • limit: optional integer (default: 20)

返回资源的最大数量,范围为 1 至 100,默认为 20。

format: int64, minimum: 1, maximum: 100

  • metadata: optional map[string]

使用 metadata[key]=value 提供精确匹配的字符串条件。所有键值对都必须匹配。最多 16 对,键长为 1 至 64 个字符,值最长为 512 个字符。筛选结果采用最终一致性,元数据变更可能延迟显示。

  • order: optional "asc" or "desc" (default: "desc")

返回资源的排序方式,默认为 desc。

  • "asc"

按升序返回资源。

  • "desc"

按降序返回资源。

  • status: optional VaultStatusFilter

按单个状态或状态列表筛选,例如 status=active 或 status[]=active&status[]=archived。默认包含两种状态。

  • VaultStatus = "active" or "archived"

凭证库或凭证当前为活动或已归档状态。

  • "active"

  • "archived"

  • array of VaultStatus

minItems: 0, maxItems: 16384

  • "active"

  • "archived"

返回值

  • data: array of Vault

本页返回的资源,按指定顺序排列。

minItems: 0, maxItems: 2000

  • id: string

凭证库 ID。

minLength: 0

  • created_at: integer

凭证库创建时的 Unix 时间戳,单位为秒。

format: int64

  • metadata: map[string]

与凭证库关联的键值对,例如应用或团队标识。

  • name: string or null

凭证库的可读名称(如已设置)。

minLength: 0

  • object: "vault" (default: "vault")

对象类型,固定为 vault。

  • "vault"

  • first_id: string or null

data 中第一项的资源 ID。当前页为空时为 null。

minLength: 0

  • has_more: boolean

当前页之后是否还有可获取的资源。

  • last_id: string or null

data 中最后一项的资源 ID。当前页为空时为 null。翻页时,将它作为 after 传入,并保持排序和筛选条件一致。

minLength: 0

  • object: "list" (default: "list")

对象类型,恒为 list。

  • "list"

示例

## 从环境变量读取 API 密钥。
curl https://api.openai.com/v1/vaults \
    -H 'OpenAI-Beta: agents=v1' \
    -H "Authorization: Bearer $OPENAI_API_KEY"

200 响应示例

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

{
  "data": [
    {
      "id": "id",
      "created_at": 0,
      "metadata": {
        "foo": "string"
      },
      "name": "name",
      "object": "vault"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id",
  "object": "list"
}
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号