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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file notte_sdk-1.8.11.tar.gz.
File metadata
- Download URL: notte_sdk-1.8.11.tar.gz
- Upload date:
- Size: 71.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b39b6403c5bbcc8eb905e6086ef821559b4b0428894d2e22959a8319eb732717
|
|
| MD5 |
b84af6789bf9ba0b1266136715aaaee6
|
|
| BLAKE2b-256 |
2aad4d8344cfdcf2648e9043acc12e8a64145bc43b7d74dbe15942a223cf0181
|
File details
Details for the file notte_sdk-1.8.11-py3-none-any.whl.
File metadata
- Download URL: notte_sdk-1.8.11-py3-none-any.whl
- Upload date:
- Size: 81.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
63dcb6e1c7b7d471b6289cc37c46dc8fac72fcbe7cb98a348f5c4d8c10124f34
|
|
| MD5 |
1d2e20992607b324d3666bdebb359186
|
|
| BLAKE2b-256 |
c98ad2c6c364432b34787af95aeefb757f5dafd9da7049001e4647dbbce009ad
|