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

Vaults

Create a vault
Vault beta().agents().vaults().create(params = VaultCreateParams.none(), requestOptions = RequestOptions.none())
POST
/vaults
Delete a vault
VaultDeleted beta().agents().vaults().delete(params = VaultDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE
/vaults/{vault_id}
List vaults
VaultListPage beta().agents().vaults().list(params = VaultListParams.none(), requestOptions = RequestOptions.none())
GET
/vaults
Retrieve a vault
Vault beta().agents().vaults().retrieve(params = VaultRetrieveParams.none(), requestOptions = RequestOptions.none())
GET
/vaults/{vault_id}
Update a vault
Vault beta().agents().vaults().update(params = VaultUpdateParams.none(), requestOptions = RequestOptions.none())
POST
/vaults/{vault_id}
Models
class Vault:

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

class VaultDeleted:

Confirmation that a vault was deleted.

enum VaultStatus:

Whether a vault or credential is active or archived.

class VaultStatusFilter:
union

One or more lifecycle statuses to include when listing vaults or credentials.

VaultsCredentials

Create a vault credential
Credential beta().agents().vaults().credentials().create(params, requestOptions = RequestOptions.none())
POST
/vaults/{vault_id}/credentials
Delete a vault credential
CredentialDeleted beta().agents().vaults().credentials().delete(params, requestOptions = RequestOptions.none())
DELETE
/vaults/{vault_id}/credentials/{credential_id}
List vault credentials
CredentialListPage beta().agents().vaults().credentials().list(params = CredentialListParams.none(), requestOptions = RequestOptions.none())
GET
/vaults/{vault_id}/credentials
Retrieve a vault credential
Credential beta().agents().vaults().credentials().retrieve(params, requestOptions = RequestOptions.none())
GET
/vaults/{vault_id}/credentials/{credential_id}
Update a vault credential
Credential beta().agents().vaults().credentials().update(params, requestOptions = RequestOptions.none())
POST
/vaults/{vault_id}/credentials/{credential_id}
Models
class Credential:

Metadata for a stored credential. Secret values are never returned.

class CredentialAuth:
union

The authentication configuration of a vault credential, excluding secrets.

class CredentialAuthCreateParam:
union

Authentication credentials for an MCP server or an OpenAI-hosted environment.

class CredentialAuthRotateParam:
union

Updates to a vault credential without changing its authentication method or destination configuration.

class CredentialDeleted:

Confirmation that a vault credential was deleted.

class CredentialNetworking:
union

Destination permissions for an environment-variable credential. These do not grant network access to the environment.

class CredentialNetworkingParam:
union

Destination permissions for an environment-variable credential. These do not grant network access to the environment.

class McpOAuthTokenEndpointAuth:
union

The client authentication method used for OAuth token refresh.

class McpOAuthTokenEndpointAuthCreateParam:
union

Client authentication credentials for OAuth token refresh.

class McpOAuthTokenEndpointAuthRotateParam:
union

Client-secret updates that preserve the credential’s OAuth authentication method.