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

client.beta.agents.vaults.delete(stringvaultID, RequestOptionsoptions?): VaultDeleted { id, deleted, object }
DELETE/vaults/{vault_id}

Deletes a vault and all its credentials. See vaults.

ParametersExpand Collapse
vaultID: string
minLength0
maxLength1048576
ReturnsExpand Collapse
VaultDeleted { id, deleted, object }

Confirmation that a vault was deleted.

id: string

The ID of the deleted vault.

minLength0
deleted: boolean

Whether the resource was deleted. Always true.

object: "vault.deleted"

The object type. Always vault.deleted.

Delete a vault

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const vaultDeleted = await client.beta.agents.vaults.delete('vault_id');

console.log(vaultDeleted.id);
{
  "id": "id",
  "deleted": true,
  "object": "vault.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "vault.deleted"
}