SDK Overview¶
The BotManifold Python SDK provides a convenient way to interact with the platform programmatically.
Features¶
- Verify Policies: Run safety verification on your robot control policies
- Arena Submissions: Submit policies and compete on the leaderboard
- Check Status: Monitor submission progress with built-in polling
- Local Testing: Run a local policy server with
botmanifold serve
Quick Links¶
- Installation - Get the SDK set up
- Quick Start - Verify your first policy
- API Reference - Complete SDK documentation
Basic Usage¶
from botmanifold import BotManifoldClient
# Initialize client (reads BOTMANIFOLD_API_KEY env var)
client = BotManifoldClient(api_key="bm_...")
# Verify policy safety (primary use case)
report = client.verify.run("policy.zip", scenario="messy_room")
print(f"Verdict: {report.verdict}")
print(f"Score: {report.score}")
# Arena submission
submission = client.arena.submit("policy.zip", scenario="messy_room")
result = client.arena.wait(submission.id)
print(f"Arena Score: {result.score}")
Requirements¶
- Python 3.10+
- requests
- click
Installation¶
See Installation for detailed instructions.