Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Retrieve a vault

beta.agents.vaults.retrieve(strvault_id) -> Vault
GET/vaults/{vault_id}

Retrieves a vault by its ID. See vaults.

ParametersExpand Collapse
vault_id: str
minLength0
maxLength1048576
ReturnsExpand Collapse
class Vault: …

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

id: str

The ID of the vault.

minLength0
created_at: int

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

formatint64
metadata: Dict[str, str]

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

name: Optional[str]

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

minLength0
object: Literal["vault"]

The object type. Always vault.

Retrieve a vault

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),  # This is the default and can be omitted
)
vault = client.beta.agents.vaults.retrieve(
    "vault_id",
)
print(vault.id)
{
  "id": "id",
  "created_at": 0,
  "metadata": {
    "foo": "string"
  },
  "name": "name",
  "object": "vault"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "metadata": {
    "foo": "string"
  },
  "name": "name",
  "object": "vault"
}