Skip to main content
Read the Notte skill 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.
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