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.10.tar.gz (26.7 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.10-py3-none-any.whl (34.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dojo_sdk_client-0.1.10.tar.gz
Algorithm Hash digest
SHA256 4a5c773667478c7dbeff0b448e62c5a44bdb6948fd3bbefbfc8162785782c886
MD5 bbec637d374b689048c5eb99f4a4cb6f
BLAKE2b-256 56efafcecd59a7cd822fe68fc4f68e5f728bc2f582f14180c846180e32ba9b8f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dojo_sdk_client-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 dd1b29a63ffbe99ea0c182427ea86fbab791fbb8bc604d0bedcdeeb7d07874a6
MD5 0e94af3f0f3b5781f7087e7d3db62b6e
BLAKE2b-256 34821535409543d8e129cd576e42fde971f257a4ad68471d252efff992d6bbaa

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