> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notte.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# client.vaults

<Tip>
  Read [the Notte skill](https://notte.cc/skill.md) and follow its setup instructions when setting up Notte or building browser automation. This is the shared source for CLI setup, authentication, and the browser-to-code workflow.
</Tip>

[Source: node-sdk/src/client.ts](https://github.com/nottelabs/notte/blob/main/node-sdk/src/client.ts)

Client-bound vault API operations. `list()` retains its array return value.

These operations use the configured client's authentication and transport. Signatures below preserve positional arguments, optional parameters, and return types. See the [OpenAPI schema](https://api.notte.cc/openapi.json) for HTTP request and response fields.

## list

```typescript theme={null}
client.vaults.list(options?: VaultListOptions): Promise<Vault[]>;
```

## create

vaultCreate: /vaults/create. Returns the API response body.

```typescript theme={null}
client.vaults.create(body: VaultCreateData["body"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<VaultCreateData["headers"]>, "x-notte-api-key">; }): Promise<Vault>;
```

## credentialsAdd

vaultCredentialsAdd: /vaults/\{vault\_id}/credentials. Returns the API response body.

```typescript theme={null}
client.vaults.credentialsAdd(vaultId: VaultCredentialsAddData["path"]["vault_id"], body: VaultCredentialsAddData["body"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<VaultCredentialsAddData["headers"]>, "x-notte-api-key">; }): Promise<AddCredentialsResponse>;
```

## credentialsDelete

vaultCredentialsDelete: /vaults/\{vault\_id}/credentials. Returns the API response body.

```typescript theme={null}
client.vaults.credentialsDelete(vaultId: VaultCredentialsDeleteData["path"]["vault_id"], query: VaultCredentialsDeleteData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<VaultCredentialsDeleteData["headers"]>, "x-notte-api-key">; }): Promise<DeleteCredentialsResponse>;
```

## credentialsGet

vaultCredentialsGet: /vaults/\{vault\_id}/credentials. Returns the API response body.

```typescript theme={null}
client.vaults.credentialsGet(vaultId: VaultCredentialsGetData["path"]["vault_id"], query: VaultCredentialsGetData["query"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<VaultCredentialsGetData["headers"]>, "x-notte-api-key">; }): Promise<GetCredentialsResponse>;
```

## credentialsList

vaultCredentialsList: /vaults/\{vault\_id}. Returns the API response body.

```typescript theme={null}
client.vaults.credentialsList(vaultId: VaultCredentialsListData["path"]["vault_id"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<VaultCredentialsListData["headers"]>, "x-notte-api-key">; }): Promise<ListCredentialsResponse>;
```

## creditCardDelete

vaultCreditCardDelete: /vaults/\{vault\_id}/card. Returns the API response body.

```typescript theme={null}
client.vaults.creditCardDelete(vaultId: VaultCreditCardDeleteData["path"]["vault_id"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<VaultCreditCardDeleteData["headers"]>, "x-notte-api-key">; }): Promise<DeleteCreditCardResponse>;
```

## creditCardGet

vaultCreditCardGet: /vaults/\{vault\_id}/card. Returns the API response body.

```typescript theme={null}
client.vaults.creditCardGet(vaultId: VaultCreditCardGetData["path"]["vault_id"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<VaultCreditCardGetData["headers"]>, "x-notte-api-key">; }): Promise<GetCreditCardResponse>;
```

## creditCardSet

vaultCreditCardSet: /vaults/\{vault\_id}/card. Returns the API response body.

```typescript theme={null}
client.vaults.creditCardSet(vaultId: VaultCreditCardSetData["path"]["vault_id"], body: VaultCreditCardSetData["body"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<VaultCreditCardSetData["headers"]>, "x-notte-api-key">; }): Promise<AddCreditCardResponse>;
```

## delete

vaultDelete: /vaults/\{vault\_id}. Returns the API response body.

```typescript theme={null}
client.vaults.delete(vaultId: VaultDeleteData["path"]["vault_id"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<VaultDeleteData["headers"]>, "x-notte-api-key">; }): Promise<DeleteVaultResponse>;
```

## update

vaultUpdate: /vaults/\{vault\_id}. Returns the API response body.

```typescript theme={null}
client.vaults.update(vaultId: VaultUpdateData["path"]["vault_id"], body: VaultUpdateData["body"], requestOptions?: ResourceRequestOptions & { headers?: Omit<NonNullable<VaultUpdateData["headers"]>, "x-notte-api-key">; }): Promise<Vault>;
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.