Skip to main content

Client sdk to intearct with Dojo

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Dojo SDK Client

Python client SDK for interacting with the Dojo API

Installation

uv add dojo-sdk-client

if you want to use our example agents:

uv add "dojo-sdk-client[agents]"

if you want to use our multi-turn environment with verifiers

uv add "dojo-sdk-client[multi_turn_env]"

if you want to use our browserbase engine:

uv add "dojo-sdk-client[browserbase]"

Quick Start

Basic Task Execution

from dojo_sdk_client import BaseDojoClient
from dojo_sdk_client.types import TaskStatus

client = BaseDojoClient(api_key="your-api-key")

# Create and start task
exec_id = await client.create_task(
    task_id="tic-tac-toe/win-game",
    state={"board": [[0]*3 for _ in range(3)]}
)
await client.start_task(exec_id)

status = await client.get_task_status(exec_id)
while status.status == TaskStatus.QUEUED:
    await asyncio.sleep(1)
    status = await client.get_task_status(exec_id)

# Submit action
action = {"type": "click", "x": 100, "y": 100}
await client.submit_action(exec_id, action, "Making move")

Agent Evaluation

from dojo_sdk_client import DojoEvalClient
from dojo_sdk_client.select_engine import select_engine

engine = select_engine(API_KEY)

eval_client = DojoEvalClient(agent=agent, engine=engine)

results = await eval_client.evaluate(tasks=["tic-tac-toe/win-game", "2048/get-256-tile"], num_runners=1)

Changing Engines

from dojo_sdk_client.engines.browserbase_engine import BrowserBaseEngine

engine = BrowserBaseEngine(
    api_key="your-browserbase-api-key",
    project_id="your-browserbase-project-id",
    dojo_api_key="your-dojo-api-key"
)

eval_client = DojoEvalClient(agent=your_agent,engine=engine)

BrowserBase engine has a concurrency limit that can be controlled with the BROWSERBASE_CONCURRENT_LIMIT environment variable.

Clients

BaseDojoClient - Low-level HTTP client for direct API interactions

DojoEvalClient - High-level client for running automated evaluations

MultiTurnEnv - Multi-turn environment for running evaluations with Verifiers

Engines

DojoEngine - Default engine for running tasks using Dojo

BrowserBaseEngine - Engine for running tasks using BrowserBase

Documentation

Visit docs.trydojo.ai for complete documentation.

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

dojo_sdk_client-0.1.28.tar.gz (29.3 kB view details)

Uploaded Source

Built Distribution

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

dojo_sdk_client-0.1.28-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

Details for the file dojo_sdk_client-0.1.28.tar.gz.

File metadata

  • Download URL: dojo_sdk_client-0.1.28.tar.gz
  • Upload date:
  • Size: 29.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.15

File hashes

Hashes for dojo_sdk_client-0.1.28.tar.gz
Algorithm Hash digest
SHA256 96d3693857d3207f17c8eed7ccff54176265ac993e04fb8199ebcec91c472053
MD5 2d50a7c67bd8929c422f1b9dc12febfb
BLAKE2b-256 b93ea6d2d346981a1fe4572d16248aa854b690af19fce20e44b110c0ae0cb83f

See more details on using hashes here.

File details

Details for the file dojo_sdk_client-0.1.28-py3-none-any.whl.

File metadata

File hashes

Hashes for dojo_sdk_client-0.1.28-py3-none-any.whl
Algorithm Hash digest
SHA256 bde0464f55e4b49b82fa08b1889fe1b724a4229551aecd0736f6265d139b655e
MD5 960988f2e9583595f2c4488e930ad662
BLAKE2b-256 094f1dc96b365f374632e4239567bd65f6d62d5825ba5ebeda00c5f4ef37fb8b

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