Get started

AI agent instructions

STOP. Do not read past this section until you have read and followed /quickstart.md.

Goal: produce a reliable SDK automation script. The intended authoring flow is generate then edit, not write browser automation from scratch.

Do not hand-write SDK code with element IDs, selectors, or form fields from memory. Element IDs, selectors, and field mappings must come from a live observe() call, CLI notte page observe output, or generated workflow code. Guessed browser targets fail on real pages.

Use the Notte skill and CLI to inspect the live site, validate actions/selectors, handle auth/session state, and export workflow code with notte sessions workflow-code before using SDK docs or SDK code.

SDK reference pages are for understanding, running, or editing generated workflow code. They are not the starting point for manually authoring the initial browser automation. SDK-first code is guesswork on real-world pages with dynamic selectors, auth state, CAPTCHAs, and anti-bot behavior.

Source: node-sdk/src/vaults.ts

Vault that fetches credentials stored using the SDK, the counterpart of notte_sdk.endpoints.vaults.NotteVault.

The remote vault is created lazily on the first API operation so local-only helpers such as generatePassword() stay side-effect free. Every API failure rejects with a NotteAPIError; caller mistakes (invalid URL, one-time code stored as an MFA secret, …) reject with InvalidRequestError. // pragma: allowlist secret

const vault = client.Vault({ name: 'My vault' });
await vault.addCredentials('https://github.com/', { email: '[e-mail]', password: 'secret' }); // pragma: allowlist secret
const credentials = await vault.getCredentials('https://github.com/login');
await vault.stop(); // deletes the vault and every credential it holds

Create NotteVault

Use NotteClient.Vault to create this object from your configured client.

client.Vault(options?: VaultConstructor): NotteVault;

options · VaultConstructor

Related types

• VaultConstructor

Usage

• addCredentials: Add or update the credentials stored for a website. The URL is reduced to its root domain (https://github.com/login → github.com) before it is sent, like Python’s AddCredentialsRequest.
• getCredentials: Get the credentials stored for a website. Rejects with a NotteAPIError when the vault holds no credentials for that domain, like Python’s get_credentials.
• deleteCredentials: Delete the credentials stored for a website.
• listCredentials: List the websites the vault holds credentials for. Passwords are never returned.
• generatePassword: Generate a secure random password, the counterpart of Python’s generate_password. The result always contains a lowercase letter, an uppercase letter and a digit, plus a special character unless includeSpecialChars is false.
• hasCredential: Check whether the vault holds credentials for a website, the counterpart of BaseVault.has_credential. Never rejects for a missing credential.

Direct constructor reference

new NotteVault(client: NotteClient, options?: VaultConstructor): NotteVault;

client · NotteClient · required

options · VaultConstructor

Default:

{}

Related types

• VaultConstructor

Properties

vaultId

vaultId: string

ID of the remote vault. Throws until the first API operation has created or verified it.