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

Delete a vault

beta.agents.vaults.delete(strvault_id) -> VaultDeleted
DELETE/vaults/{vault_id}

Deletes a vault and all its credentials. See vaults.

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

Confirmation that a vault was deleted.

id: str

The ID of the deleted vault.

minLength0
deleted: bool

Whether the resource was deleted. Always true.

object: Literal["vault.deleted"]

The object type. Always vault.deleted.

Delete 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_deleted = client.beta.agents.vaults.delete(
    "vault_id",
)
print(vault_deleted.id)
{
  "id": "id",
  "deleted": true,
  "object": "vault.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "vault.deleted"
}