Skip to main content

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.

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.
Live View allows you to watch your browser sessions in real-time as they execute, making it easy to debug and monitor automation.

​
Quick Start

Open a live viewer automatically when the session starts:
quick_start.py
from notte_sdk import NotteClient

client = NotteClient()

# Live viewer opens automatically
with client.Session(open_viewer=True) as session:
    session.execute(type="goto", url="https://example.com")
    session.execute(type="click", selector="button.submit")
    # Watch it happen in your browser!

​
Manual Live View

Open the live viewer manually at any point during the session:
manual.py
from notte_sdk import NotteClient

client = NotteClient()

with client.Session() as session:
    session.execute(type="goto", url="https://example.com")

    # Open live viewer
    session.viewer()

    # Continue automation while watching
    session.execute(type="click", selector="button.submit")

​
Viewer Types

Notte supports multiple viewer types:

​
Browser Viewer (Default)

Frame-by-frame replay in your browser:
viewer_browser.py
from notte_sdk import NotteClient

client = NotteClient()

with client.Session() as session:
    session.execute(type="goto", url="https://example.com")

    # Opens browser viewer
    session.viewer_browser()

​
CDP Viewer

Chrome DevTools Protocol debugger:
viewer_cdp.py
from notte_sdk import NotteClient

client = NotteClient()

with client.Session() as session:
    session.execute(type="goto", url="https://example.com")

    # Opens CDP debugger
    session.viewer_cdp()

​
Jupyter Notebook Viewer

Display live view directly in Jupyter notebooks:
viewer_notebook.py
from notte_sdk import NotteClient

client = NotteClient()

with client.Session() as session:
    session.execute(type="goto", url="https://example.com")

    # Display in notebook cell
    session.viewer_notebook()

​
Live View for Agents

Watch AI agents make decisions in real-time:
agent.py
from notte_sdk import NotteClient

client = NotteClient()

with client.Session(open_viewer=True) as session:
    agent = client.Agent(session=session, max_steps=10)

    result = agent.run(task="Find the pricing page and extract all plan prices")

    print(f"Agent completed: {result.answer}")

​
Sharing Live View

Share the viewer URL with your team for collaborative debugging:
sharing.py
from notte_sdk import NotteClient

client = NotteClient()

with client.Session() as session:
    session.execute(type="goto", url="https://example.com")

    # Get viewer URL
    debug_info = session.debug_info()
    print(f"Share this URL with your team: {debug_info.debug_url}")

    # Team can watch live while you continue
    session.execute(type="click", selector="button.submit")

​
Viewer Configuration

Set a default viewer type for all sessions:
configuration.py
from notte_sdk import NotteClient
from notte_sdk.endpoints.sessions import SessionViewerType

# Set default viewer to CDP
client = NotteClient(viewer_type=SessionViewerType.CDP)

with client.Session(open_viewer=True) as session:
    # Opens CDP viewer by default
    session.execute(type="goto", url="https://example.com")
Available viewer types:
  • SessionViewerType.BROWSER - Frame-by-frame browser viewer (default)
  • SessionViewerType.CDP - Chrome DevTools Protocol debugger
  • SessionViewerType.JUPYTER - Jupyter notebook display

​
Best Practices

​
1. Use for Development

Live view is ideal for development and debugging:
dev_environment.py
import os

from notte_sdk import NotteClient

client = NotteClient()

# Only use live view in development
is_dev = os.getenv("ENV") == "development"

with client.Session(open_viewer=is_dev) as session:
    session.execute(type="goto", url="https://example.com")

​
2. Combine with Recordings

Use live view during development, recordings for later analysis:
combine_with_recordings.py
from notte_sdk import NotteClient

client = NotteClient()

with client.Session(open_viewer=True) as session:
    # Watch it live
    session.execute(type="goto", url="https://example.com")
    session.execute(type="click", selector="button.submit")

# Get recording after session ends
replay = session.replay()
replay.download("recording.mp4")

​
3. Multiple Viewers

Open multiple viewer types simultaneously:
multiple_viewers.py
from notte_sdk import NotteClient

client = NotteClient()

with client.Session() as session:
    session.execute(type="goto", url="https://example.com")

    # Open both viewers
    session.viewer_browser()  # Frame-by-frame
    session.viewer_cdp()  # DevTools

​
Live View vs Recordings

FeatureLive ViewRecordings
TimingReal-time during executionAfter session ends
InteractivityCan observe as it happensPlayback only
Use CaseDebugging, monitoringArchiving, sharing
AvailabilityDuring session only24 hours after session

​
Next Steps

Recordings

Record sessions for later analysis

Playwright

Connect with Playwright via CDP

Session Lifecycle

Understand session management

Session Configuration

Configure session parameters