Skip to main content
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/client.ts Entry point for sessions, agents, functions, vaults, personas, and session files.
NotteClientConfig
Default:

Usage

  • withDbPreview: Add the database preview branch to a websocket URL served by the Notte API. The websocket handshake reads the branch from the query string, so without it a preview-branch session is looked up in the default database.
  • healthCheck: Health check the Notte API. Resolves when the API answers 200 and rejects with a NotteAPIError (or a network error) otherwise.
  • Session: Create a new session
  • Files: Access files owned by a specific session, including closed sessions.
  • FileStorage: File storage to attach to a session, the counterpart of client.FileStorage().
  • Agent: Create a new agent
  • Vault: Create or access a vault
  • Persona: Create or access a persona
  • NotteFunction: Create or access a function
  • Function: Alias of NotteFunction, matching client.Function in Python.
  • search: Search the public web (POST /search). Returns ranked results by default, an answer with sources with outputType: 'sourcedAnswer', or structured output with outputType: 'structured'.
  • scrape: Scrape a webpage directly (without session).

sessions

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

agents

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

vaults

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

functions

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

anything

Anything API (POST /anything/start).

secrets

Workspace secrets (/secrets).

managedAuth

Managed authentication: verify connections, request login, and wait for readiness.

usage

Usage and billing (/usage, /usage/logs).

personas

Personas client for listing and managing personas

profiles

Client-bound profile API operations, generated from OpenAPI.