Skip to main content

The SDK for Notte

Project description

Notte SDK

The Notte SDK is a powerful Python library that provides a seamless interface for interacting with web automation and AI-powered agents. It enables developers to create, manage, and monitor web automation sessions and AI agents with ease.

Key Features

  • Session Management: Create, monitor, and control web automation sessions
  • Agent Orchestration: Deploy and manage AI agents for automated web tasks
  • CDP Integration: Direct Chrome DevTools Protocol integration for advanced browser control
  • Web Automation: Built-in tools for web page observation, scraping, and action execution
  • Real-time Monitoring: Live session viewing and debugging capabilities

Installation

pip install notte-sdk

Quick Start

import os
from notte_sdk import NotteClient

# Initialize the client
notte = NotteClient(api_key=os.getenv("NOTTE_API_KEY"))

# Run an AI agent
with notte.Session(open_viewer=True) as session:
    agent = notte.Agent(session=session)
    agent.run(
        task="What is the capital of France?",
        url="https://www.google.com",
    )

Core Components

Session Management

The SDK provides comprehensive session management capabilities:

from notte_sdk import NotteClient
notte = NotteClient()

# Start a new session
with notte.Session(timeout_minutes=5) as session:
    # Get session status
    status = session.status()
    # View live session
    session.viewer()

Agent Operations

Deploy and manage AI agents for automated tasks:

from notte_sdk import NotteClient
notte = NotteClient()
# Run an agent with specific tasks

with notte.Session(open_viewer=True) as session:
    agent = notte.Agent(session=session)
    # Start an agent with non-blocking call
    agent.start(
        task="Summarize the content of the page",
        url="https://www.google.com"
    )

# Monitor agent status
status = agent.status()
# List active agents
agents = notte.agents.list()

# Stop an agent
agent.stop()

Web Automation

Execute web automation tasks with built-in tools:

from notte_sdk import NotteClient
notte = NotteClient()

with notte.Session(open_viewer=True) as session:
    # Observe a web page
    _ = session.execute(type="goto", url="https://www.google.com")
    obs = session.observe()
    # Execute actions
    action = obs.space.sample(type='click')
    result = session.execute(action)
    assert result.success
    # Scrape content
    markdown = session.scrape()
    print(markdown)

CDP Integration

Integrate with Chrome DevTools Protocol for advanced browser control:

from patchright.sync_api import sync_playwright
from notte_sdk import NotteClient
notte = NotteClient()

with notte.Session(proxies=False) 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")

Advanced Features

  • Real-time session monitoring and debugging
  • Automated web scraping and content analysis
  • AI-powered task automation
  • Flexible session configuration
  • Comprehensive error handling and logging

Support

For support, please contact us at hello@notte.cc

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notte_sdk-1.8.16.tar.gz (72.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

notte_sdk-1.8.16-py3-none-any.whl (82.2 kB view details)

Uploaded Python 3

File details

Details for the file notte_sdk-1.8.16.tar.gz.

File metadata

  • Download URL: notte_sdk-1.8.16.tar.gz
  • Upload date:
  • Size: 72.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for notte_sdk-1.8.16.tar.gz
Algorithm Hash digest
SHA256 927392cfadc03cbc61c457f7e4e8fe61841637a12aafeb8041a69b609d8fd961
MD5 2fa9f30289a240d22c6f2e4cbf56cdcf
BLAKE2b-256 96fbefa0ffa9227d5a6956b84f48d6fe609ddaa05cdd48790c987295e6058101

See more details on using hashes here.

File details

Details for the file notte_sdk-1.8.16-py3-none-any.whl.

File metadata

  • Download URL: notte_sdk-1.8.16-py3-none-any.whl
  • Upload date:
  • Size: 82.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for notte_sdk-1.8.16-py3-none-any.whl
Algorithm Hash digest
SHA256 f0411585bb64fd5d0d0e3cc90e944d258326ee3e1db55758a77bf0223caf6faa
MD5 a76cb5b81d23e4b4b9b96458da24a133
BLAKE2b-256 70b9a1534d56531fa76dde29a3919709097fb9450a18f4f27a031ee3609cda25

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page