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",
    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

eval_client = DojoEvalClient(agent=your_agent, api_key="your-api-key")

results = await eval_client.evaluate(
    tasks=["tic-tac-toe", "2048"],
    num_runners=2
)

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, api_key="your-api-key", 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.9.tar.gz (26.8 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.9-py3-none-any.whl (34.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dojo_sdk_client-0.1.9.tar.gz
Algorithm Hash digest
SHA256 305fdd1b208dd2699054d540a072ee58aa5249adc6c670470c11b9691a54249e
MD5 fc7a9c316dffe46f61057c0aa69f360d
BLAKE2b-256 3cd7c1a044e4beb4beba07106d04b15ed84773d41b07b13884da2360111890aa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dojo_sdk_client-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 c92983489323ed1cd0a7990bd3f13300e6330872ded932f527051ab4c48ab058
MD5 aaebb894ee9c8670d487b54a26009060
BLAKE2b-256 05184516f250e9b0f32ac26bda79830a2052a517c6d81a211d262e6389965dc2

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