Skip to main content

Yutori Python SDK & CLI

PyPI version Python 3.9+

The official Python SDK and CLI for the Yutori API — build agents that monitor, research, and browse the web, and operate computers with Yutori.

The SDK offers sync and async clients with full type annotations, plus a yutori CLI for authentication and managing resources from the terminal.

AI agent install (recommended)

Paste this into Claude Code, Codex, Cursor, Windsurf, or another coding agent:

Use https://yutori.com/api/llms.txt and set up Yutori for me.

Manual install

On macOS or Linux, the recommended setup is the one-line installer:

curl -fsSL https://yutori.com/install.sh | bash

Installs the global yutori CLI via uv tool install and prompts to add the SDK to your project, run yutori auth login, register the MCP server, install workflow skills, and verify with a browsing task.

Python 3.9+ is required for the SDK.

Non-interactive install (CI, pipe, AI coding agent)

The SDK install, auth, and verification steps are skipped — auth needs a browser, verification needs an API key. MCP server and workflow skills install automatically without prompts.

To scope the MCP install to one coding agent, set YUTORI_INSTALL_CLIENT=<slug> (e.g. claude-code, codex, cursor). Unset, it registers for claude-code, codex, cursor, and gemini-cli. Run npx add-mcp list-agents for the full slug list.

Uninstall the CLI later
curl -fsSL https://yutori.com/uninstall.sh | bash

Removes the global yutori CLI. Saved credentials at ~/.yutori/ are left in place so they survive reinstalls — rm -rf ~/.yutori manually if you want a clean slate. Set YUTORI_UNINSTALL_ASSUME_YES=1 for scripted runs.

Install the package manually
pip install yutori

Or add it to an existing project with uv:

uv add yutori
Authenticate manually

Run this once to save your API key:

yutori auth login

This opens your browser to log in with your Yutori account and saves an API key to ~/.yutori/config.json. The SDK and CLI automatically pick it up.

If you installed the package with uv add, run uv run yutori auth login instead.

Or use an env var / pass the key explicitly:

from yutori import YutoriClient

client = YutoriClient()                  # Uses saved credentials or YUTORI_API_KEY
client = YutoriClient(api_key="yt-...")  # Or pass explicitly

Resolution order: explicit api_key > YUTORI_API_KEY env var > ~/.yutori/config.json.

Configure MCP server and skills manually

The installer sets these up automatically when Node.js is available. To do it manually:

npx add-mcp "uvx yutori-mcp"
npx skills add yutori-ai/yutori-mcp -g

The first command registers the Yutori MCP server with your editor. The second installs workflow skills for Claude Code and compatible agents.

API Overview

The Yutori API provides four main capabilities:

API Description SDK Namespace
Navigator Browser- and computer-use models (Navigator n1.5, n2) client.chat
Browsing One-time browser automation tasks client.browsing
Research Deep web research using 100+ tools client.research
Scouting Continuous web monitoring on a schedule client.scouts

Navigator API

The Navigator API serves Yutori's models: Navigator n1.5 operates a webpage in a browser and Navigator n2 operates a complete desktop. Both take a task and a screenshot and return the next actions as tool_calls; your code executes them, sends the results back, and calls the model again until it indicates stop. The endpoint follows the OpenAI Chat Completions interface, so client.chat is a drop-in OpenAI-compatible client.

Navigator n1.5 (browser use)

Capture a screenshot of the page and send it with the task:

from yutori import AsyncYutoriClient
from yutori.navigator import aplaywright_screenshot_to_data_url
from playwright.async_api import async_playwright

async with AsyncYutoriClient() as client, async_playwright() as p:
    browser = await p.chromium.launch()
    page = await browser.new_page()
    await page.goto("https://www.yutori.com")

    image_url = await aplaywright_screenshot_to_data_url(page)

    response = await client.chat.completions.create(
        messages=[
            {
                "role": "user",
                "content": [
                    {"type": "text", "text": "List the team member names."},
                    {"type": "image_url", "image_url": {"url": image_url}},
                ],
            }
        ],
    )

    message = response.choices[0].message
    print(message.content)  # Model's thoughts
    for tool_call in message.tool_calls or []:
        # Execute the requested browser action on `page`, append the tool
        # result to the conversation, capture a fresh screenshot, and call
        # the model again...
        ...

This snippet shows a single model call. In practice, you'll run an agent loop: execute the returned actions on the page, capture a fresh screenshot, and call the model again until it returns text with no tool_calls. Complete agent loops live in examples/.

The SDK defaults to Navigator n1.5 (n1.5-latest). Navigator n1.5 requests support selectable tool sets, disable_tools, and structured JSON output via json_schema (returned as response.parsed_json). See the Navigator reference for model IDs, parameters, and the full action space.

Navigator n2 (computer use)

Navigator n2 operates a full desktop. It answers with computer_batch calls — an ordered sequence of GUI actions, answered with one screenshot taken after the last one — and bash calls, answered with the command's output. Use model="n2" and pin the tool set:

from yutori import AsyncYutoriClient
from yutori.navigator import TOOL_SET_COMPUTER_USE_LATEST, screenshot_to_data_url

async with AsyncYutoriClient() as client:
    # A full-screen capture, kept at the display's own size (the default resize_to is a browser viewport).
    image_url = screenshot_to_data_url(screenshot_bytes, resize_to=(screen_width, screen_height))

    response = await client.chat.completions.create(
        model="n2",
        tool_set=TOOL_SET_COMPUTER_USE_LATEST,
        messages=[
            {
                "role": "user",
                "content": [
                    {"type": "text", "text": "Open Calculator and compute 17 * 23."},
                    {"type": "image_url", "image_url": {"url": image_url}},
                ],
            }
        ],
    )

    message = response.choices[0].message
    print(message.content)  # Model's thoughts
    for tool_call in message.tool_calls or []:
        # Run the batch's actions in order on the desktop (or run the bash
        # command), append one tool result per call, and call the model again...
        ...

N2ComputerAgent runs this loop for you against any desktop you can screenshot and drive. examples/navigator_n2_daytona.py is a complete agent on a sandbox Daytona Linux desktop, with everything Daytona-specific in one small adapter class; Building agents with n2 walks through it.

Drive your own local Mac

Yutori MCP ships the local harness, built on the same N2ComputerAgent:

uvx yutori-mcp computer-use setup
uvx yutori-mcp computer-use run "In Calculator, compute 17 * 23 and report the result." --app Calculator

See the Navigator n2 reference for the tools, actions, coordinate system, and request fields.

The SDK also accepts the immutable computer_use_tools-20260818 browser set for replay. It is not a desktop set: its extra goto_url call requires a computer handler that implements async goto_url(url: str). The bundled desktop and public Cua sandbox adapters deliberately return a recoverable unsupported-environment result for that browser-only call.

Agent-loop helpers

The yutori.navigator subpackage exposes optional helpers for typical agent loops:

Helper Purpose
aplaywright_screenshot_to_data_url(page) Capture a Playwright screenshot as a Navigator-optimized WebP data URL.
denormalize_coordinates(coords, width, height) Map the Navigator 1000×1000 coordinate space to viewport pixels.
format_task_with_context(task, ...) Append location, timezone, and current date to a task message.
format_stop_and_summarize(task) Ask the model to summarize when hitting max steps or an error.
trimmed_messages_to_fit(messages, max_bytes, keep_recent) Drop older screenshots to stay under the API size limit.
map_key_to_playwright(key) / map_keys_individual(keys) Convert Navigator n1.5 lowercase key names to Playwright format.
yutori.navigator.tools Packaged JS reference implementations for Navigator n1.5 browser tool sets (extract_elements, find, set_element_value, execute_js).
N2ComputerAgent / TOOL_SET_COMPUTER_USE_LATEST The stable Navigator n2 agent loop and current computer-use tool set (SDK 0.9.3+).

Full helper reference: api.md.

If you'd rather not manage browser infrastructure, use the Browsing API below, which runs the Navigator on Yutori's cloud browser.

Browsing API

Run one-time browser automation tasks on Yutori's cloud browser (or on Yutori Local with the user's logged-in desktop sessions):

task = client.browsing.create(
    task="Give me a list of all employees (names and titles) of Yutori.",
    start_url="https://yutori.com",
)

# Poll for completion
import time
while True:
    result = client.browsing.get(task["task_id"])
    if result["status"] in ("succeeded", "failed"):
        break
    time.sleep(5)

print(result)

Common options: require_auth=True for login flows, browser="local" for Yutori Local, webhook_url=... for async completion notifications. Failed tasks may include a rejection_reason.

client.browsing.list() enumerates your browsing tasks — omit limit to get them all, or pass status (running/succeeded/failed) and cursor to filter and paginate.

Structured output

Define the output structure with a JSON Schema dict or a Pydantic model:

from pydantic import BaseModel  # optional dependency

class Employee(BaseModel):
    name: str
    title: str

task = client.browsing.create(
    task="Give me a list of all employees (names and titles) of Yutori.",
    start_url="https://yutori.com",
    output_schema=Employee,  # Auto-converted to JSON Schema
    webhook_url="https://example.com/webhook",
)

The same output_schema pattern applies to client.research.create and client.scouts.create.

Research API

Perform deep web research using 100+ MCP tools (search engines, APIs, data sources):

task = client.research.create(
    query="What are the latest developments in quantum computing from the past week?",
    user_timezone="America/Los_Angeles",
)

# Poll for results
while True:
    result = client.research.get(task["task_id"])
    if result["status"] in ("succeeded", "failed"):
        break
    time.sleep(5)

Failed tasks may include a rejection_reason.

client.research.list() enumerates your research tasks — handy for exporting or recovering task IDs from a large batch. Omit limit to get them all, or pass status / cursor to filter and paginate:

completed = client.research.list(status="succeeded")
for t in completed["tasks"]:
    print(t["task_id"], t["created_at"])

Scouting API

Scouts run on a schedule to monitor the web and notify you when relevant updates occur:

scout = client.scouts.create(
    query="News, product updates, and announcements about Yutori AI",
    output_interval=86400,  # Daily (seconds, min 1800)
    webhook_url="https://example.com/webhook",
)

# Manage scouts
scouts = client.scouts.list(status="active")
client.scouts.update(scout["id"], status="paused")
client.scouts.update(scout["id"], status="active")
updates = client.scouts.get_updates(scout["id"], limit=20)
client.scouts.delete(scout["id"])

Async Usage

AsyncYutoriClient mirrors YutoriClient with async methods:

import asyncio
from yutori import AsyncYutoriClient

async def main():
    async with AsyncYutoriClient() as client:
        usage = await client.get_usage()
        scouts = await client.scouts.list()
        print(usage, scouts)

asyncio.run(main())

Error Handling

from yutori import YutoriClient, APIError, APIConnectionError, AuthenticationError

try:
    client.get_usage()
except AuthenticationError as e:
    print(f"Invalid API key: {e}")
except APIConnectionError as e:
    print(f"Connection failed: {e}")
except APIError as e:
    print(f"API error (status {e.status_code}): {e.message}")

CLI

# Authentication
yutori auth login      # Log in via browser
yutori auth status     # Show current auth status
yutori auth logout     # Remove saved credentials

# Scouts
yutori scouts list
yutori scouts create -q "monitor for news"
yutori scouts create -q "monitor for news" -i daily -tz America/New_York
yutori scouts get SCOUT_ID
yutori scouts delete SCOUT_ID

# Browsing
yutori browse list
yutori browse list --limit 20 --status succeeded
yutori browse run "extract all prices" https://example.com/products
yutori browse run "log in and continue" https://example.com/login --require-auth
yutori browse run "export dashboard data" https://example.com/dashboard --browser local
yutori browse get TASK_ID

# Research
yutori research list
yutori research list --limit 10 --status running
yutori research run "latest developments in quantum computing" -tz America/Los_Angeles
yutori research get TASK_ID

# Usage
yutori usage

Run yutori --help or yutori <command> --help for full options.

Examples

See examples/ for complete working examples: Navigator n1.5 browser loops, custom tools, and a Navigator n2 computer-use agent on a Daytona desktop.

Contributing

See CONTRIBUTING.md for development setup.

Documentation

License

Apache 2.0 — see LICENSE.

Download files

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

Source Distribution

yutori-0.9.3.tar.gz (335.1 kB view details)

Uploaded Source

Built Distribution

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

yutori-0.9.3-py3-none-any.whl (253.9 kB view details)

Uploaded Python 3

File details

Details for the file yutori-0.9.3.tar.gz.

File metadata

  • Download URL: yutori-0.9.3.tar.gz
  • Upload date:
  • Size: 335.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for yutori-0.9.3.tar.gz
Algorithm Hash digest
SHA256 ed96a5bbd6b5b161c8fd2687ff343ff254309fb2c006ea0952745247f929b1ba
MD5 214bfd79366e5bde15bdf46585fbc474
BLAKE2b-256 7ecb70e708fe115312524f94ccb9918d4d5867edba44b24b6592fc55afa0d80f

See more details on using hashes here.

Provenance

The following attestation bundles were made for yutori-0.9.3.tar.gz:

Publisher: publish_to_pypi.yml on yutori-ai/yutori-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file yutori-0.9.3-py3-none-any.whl.

File metadata

  • Download URL: yutori-0.9.3-py3-none-any.whl
  • Upload date:
  • Size: 253.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for yutori-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d9ead4244c90c8b02d85ca85e85953d72eb4c5d3f692ad7a12ce631534772d69
MD5 f2cb9bc0e23d17a8b79315eadac2dfa1
BLAKE2b-256 b977f1f5d874f128a701fd85ecd7c7bb7faf85c53e18bd3acb293d98dd4ab5ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for yutori-0.9.3-py3-none-any.whl:

Publisher: publish_to_pypi.yml on yutori-ai/yutori-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.9.14

2 files

0.9.13

2 files

0.9.12

2 files

0.9.11

2 files

0.9.10

2 files

0.9.9

2 files

0.9.8

2 files

0.9.7

2 files

0.9.6

2 files

0.9.5

2 files

0.9.4

2 files

This release

0.9.3 This release

2 files

0.9.2

2 files

0.9.1

2 files

0.9.0

2 files

0.8.1

2 files

0.8.0

2 files

0.7.9

2 files

0.7.8

2 files

0.7.7

2 files

0.7.6

2 files

0.7.5

2 files

0.7.4

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.1

2 files

0.6.0

2 files

0.5.0

2 files

0.4.10

2 files

0.4.9

2 files

0.4.8

2 files

0.4.7

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page