API Reference

Beta

Agents

Vaults

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List vaults

beta.agents.vaults.list(**kwargs) -> CursorPage<Vault { id, created_at, metadata, 2 more } >

GET/vaults

Lists vaults using ID-based pagination. See vaults.

ParametersExpand Collapse

after: String

Return resources after this resource ID in the selected order.

minLength0

maxLength1048576

limit: Integer

The maximum number of resources to return. Defaults to 20. Values are clamped between 1 and 100.

formatint64

minimum0

order: :asc | :desc

Sort order by the created_at timestamp. Use asc for ascending order or desc for descending order. Defaults to desc.

status: VaultStatusFilter

Filter by one status or a list, such as status=active or status[]=active&status[]=archived. Both statuses are included by default.

ReturnsExpand Collapse

class Vault { id, created_at, metadata, 2 more }

A collection of credentials for MCP servers and OpenAI-hosted environments.

id: String

The ID of the vault.

minLength0

created_at: Integer

The Unix timestamp, in seconds, when the vault was created.

formatint64

metadata: Hash[Symbol, String]

Key-value pairs associated with the vault, such as an application or team identifier.

name: String

The human-readable name of the vault, if set.

minLength0

object: :vault

The object type. Always vault.

List vaults

Ruby

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

page = openai.beta.agents.vaults.list

puts(page)

200 example

{
  "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"
}

Returns Examples

200 example

{
  "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"
}