Quickstart

Get started in a few seconds

How do you want to get started?

Browser Session

Connect to a cloud browser via CDP

Web Agent

Run an AI agent on the browser

Scraping

Extract structured data from a page

---

Prerequisites

Before you start, you’ll need an API key and a local environment configured to use it.

1. Get an API key

   Create an account on the Console to get your API key.

2. Export your API key

   Python / Node.js

   export NOTTE_API_KEY=your_api_key_here
   

   from notte_sdk import NotteClient
   
   client = NotteClient()  # reads NOTTE_API_KEY automatically
   

   import { NotteClient } from 'notte-sdk';
   
   const client = new NotteClient({
     apiKey: process.env.NOTTE_API_KEY,
   });
   
3. Install the SDK

   Python (requires >= 3.11)

   pip install notte-sdk playwright
   

   npm install notte-sdk playwright-core
   

Both Python and JavaScript quickstarts below use the official Notte SDK. Start with Browser Session if you want the shortest path to a working integration.

---

Browser Session

Create a cloud browser session and control it with Playwright over CDP.

Python

from playwright.sync_api import sync_playwright
from notte_sdk import NotteClient

client = NotteClient()

with client.Session(open_viewer=True) as session:
    cdp_url = session.cdp_url()

    with sync_playwright() as p:
        browser = p.chromium.connect_over_cdp(cdp_url)
        page = browser.contexts[0].pages[0]
        page.goto("https://www.google.com")
        page.screenshot(path="screenshot.png")

import { chromium } from 'playwright-core';
import { NotteClient } from 'notte-sdk';

const notte = new NotteClient({
  apiKey: process.env.NOTTE_API_KEY,
});

await notte.Session({ open_viewer: true }).use(async (session) => {
  const status = await session.status();
  const cdpUrl = status.cdp_url;

  if (!cdpUrl) {
    throw new Error('Session did not return a cdp_url');
  }

  const browser = await chromium.connectOverCDP(cdpUrl);

  try {
    const page = browser.contexts()[0].pages()[0];
    await page.goto('https://news.ycombinator.com');

    const topStories = await page.locator('.titleline > a').allInnerTexts();

    console.log('Top 5 Hacker News stories:');
    topStories.slice(0, 5).forEach((title, index) => {
      console.log(`${index + 1}. ${title}`);
    });
  } finally {
    await browser.close();
  }
});

Learn more about Sessions

Proxies, anti-detection, captcha solving, and more.

---

Web Agent

Run an AI agent that browses and completes tasks autonomously.

Python

from notte_sdk import NotteClient

client = NotteClient()

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

    response = agent.run(
        task="Browse on Notte docs and book a demo for me",
        url="https://docs.notte.cc"
    )
    print(response)

import { NotteClient } from 'notte-sdk';

const client = new NotteClient({
  apiKey: process.env.NOTTE_API_KEY,
});

await client.Session({ open_viewer: true }).use(async (session) => {
  const agent = client.Agent({ session, max_steps: 5 });

  const response = await agent.run({
    task: 'Browse on Notte docs and book a demo for me',
    url: 'https://docs.notte.cc',
  });

  console.log(response);
});

Learn more about Agents

Models, reasoning, structured output, and more.

---

Scraping

Extract structured data from any page using AI.

Python

from pydantic import BaseModel
from notte_sdk import NotteClient

class HackerNewsPost(BaseModel):
    title: str
    url: str
    points: int
    author: str

class HackerNewsFeed(BaseModel):
    posts: list[HackerNewsPost]

client = NotteClient()

result = client.scrape(
    url="https://news.ycombinator.com",
    response_format=HackerNewsFeed,
    instructions="Extract the top 5 posts from the front page"
)

for i, post in enumerate(result.data.posts, 1):
    print(f"{i}. {post.points} - {post.title}")

import { z } from 'zod';
import { NotteClient } from 'notte-sdk';

const HackerNewsPost = z.object({
  title: z.string(),
  url: z.string(),
  points: z.number(),
  author: z.string(),
});

const HackerNewsFeed = z.object({
  posts: z.array(HackerNewsPost),
});

const notte = new NotteClient({
  apiKey: process.env.NOTTE_API_KEY,
});

const result = await notte.scrape('https://news.ycombinator.com', {
  instructions: 'Extract the top 5 posts from the front page',
  response_format: HackerNewsFeed,
});

result.posts.forEach((post, index) => {
  console.log(`${index + 1}. ${post.points} - ${post.title}`);
});

Learn more about Scraping

Structured extraction, selectors, and more.