Explore the open-source repository and star us 🌟
Overview
The Votte Python SDK provides a comprehensive set of tools for interacting with the Votte 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 Votte API.
Quickstart
Install the latest version of the SDK (requires `python >= 3.11`)
Copy
pip install --upgrade votte-sdk
Configure your API key as an environment variable
You can request a free key directly from our
Copy
export VOTTE_API_KEY=<your-api-key>
Run your first agent
import os
from votte_sdk import VotteClient
votte = VotteClient(api_key=os.getenv("VOTTE_API_KEY"))
response = nvotte.agents.run(
task="Find the latest job openings on votte.cc",
max_step=5
)
Explore what the Votte Python SDK can do for you
The SDK provides a comprehensive set of tools for interacting with the Votte API.
Web Agents
Browser Sessions
Page Interactions
Vaults & Secrets
Scrape
Run a Web Agent
from votte_sdk import VotteClient
votte = VotteClient()
agent = votte.Agent()
response = agent.run(task="Find the best italian restaurant in SF and book a table for 2 at 7pm today")
status = agent.status()
from notte_sdk import NotteClient
notte = NotteClient()
agent = notte.agents.run(
task="Go to the careers page of notte.cc and list the latest job openings",
max_steps=5
)
status = notte.agents.status(agent.agent_id)
from notte_sdk import NotteClient
notte = NotteClient()
response = notte.agents.start(
task="Go to the careers page of notte.cc and list the latest job openings",
max_steps=5
)
for i in range(10):
response = notte.agents.status(response.agent_id)
if response.answer:
print(response.answer)
_ = notte.agents.stop(response.agent_id)
you can also get more control over the session and agent lifecycle by running an agent in a session explicitly:
with votte.Session(proxies=True) as session:
_ = votte.agents.run(
task="<YOUR_TASK_PROMPT>",
session_id=session.session_id
)
...
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 votte_sdk import VotteClient
votte = VotteClient()
# Get the replay of the session so far
replay = votte.sessions.replay(session_id="<your-session-id>")
# Or the agent's execution
replay = votte.agents.replay(agent_id="<your-agent-id>")
# Save the replay to a file
replay.save("replay.webp")
# Uncomment to display the replay in a Jupyter notebook
# replay.display()
