Skip to main content
Explore our GitHub repository https://github.com/nottelabs/notte and star us 🌟

​
Overview

The Notte Python SDK provides a comprehensive set of tools for interacting with the Notte API. This guide will walk you through the steps to install the SDK, configure your API key, and start using the SDK to manage your browser sessions, web agents, and page interactions.
We strongly recommend using the Python SDK for all your automation needs. It is the most efficient way to interact with the Notte API.

​
Quickstart

1

Install the latest version of the SDK (requires `python >= 3.11`)

pip install --upgrade notte-sdk
2

Configure your API key as an environment variable

You can request a free key directly from our console
export NOTTE_API_KEY=<your-api-key>
3

Run your first agent

import os
from notte_sdk import NotteClient

notte = NotteClient(api_key=os.getenv("NOTTE_API_KEY"))
with notte.Session() as session:
    agent = notte.Agent(session=session, max_steps=5)
    response = agent.run(
        task="Find the latest job openings on notte.cc",
    )

​
Explore what the Notte Python SDK can do for you

The SDK provides a comprehensive set of tools for interacting with the Notte API.
  • Web Agents
  • Browser Sessions
  • Page Interactions
  • Vaults & Secrets
  • Scrape
Learn more about web agents in the web agents guide.

​
Run a Web Agent

from notte_sdk import NotteClient

notte = NotteClient()
with notte.Session() as session:
    agent = notte.Agent(session=session, max_steps=10)
    response = agent.run(task="Find the best italian restaurant in SF and book a table for 2 at 7pm today")
    print(f"Agent terminated with status: {response.success} and answer: {response.answer}")

​
How to get visual insights about your sessions & agents

At any time during the execution of a session or an agent, you can retrieve a replay of the execution so far as a WebP image. 
from notte_sdk import NotteClient

notte = NotteClient()

with notte.Session() as session:
    _ = session.observe(url="https://duckduckgo.com")
# Save the replay to a file
replay = session.replay()
replay.save("replay.mp4")
⌘I