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/agent.ts

​
Create Agent

Use NotteClient.Agent to create this object from your configured client.
​
AgentConstructor
required

​
Usage

  • run: Run agent task (blocking) - mirrors Python run method behavior This is the main method that mirrors the Python SDK’s run method
  • start: Start an agent task (non-blocking) - mirrors Python start method
  • stop: Stop the agent - mirrors Python stop method
  • status: Get agent status - mirrors Python status method
  • hasStarted: Whether start()/run() was called on this instance (or it was built from an agent id). This is a local check and does not contact the API.
  • isActive: Whether the agent is still active on the server. Fetches the current status, like calling agent.status() in Python; an agent that was never started is not active.
​
NotteClient
required
​
AgentConstructor
required

​
agentId

Get agent ID - mirrors Python agent_id property

​
sessionId

Get session ID - mirrors Python session_id property