Documentation menu

Quickstart

Key → run → result in under five minutes.

You'll create an API key, launch a physical run on a humanoid in a kitchen replica, and read back a result with a confidence interval. Nothing here requires hardware knowledge — the defaults are the point.

  1. Install the SDK and set your key

    Keys have the rbr_live_ prefix and are read from the ROBORAMA_API_KEY environment variable by every SDK and every example on this site.

    pip install roborama-sdk    # or: npm i roborama
    export ROBORAMA_API_KEY=rbr_live_...
  2. Launch a run

    Pin a robot (model@firmware), an environment (id@revision), and a task. episodes="auto(ci=0.95, moe=0.03)" sizes the run for a ±3-point margin of error at 95% confidence — statistics as an input, not an afterthought. With no policy attached, the run exercises the catalogue baseline policy for the task, so you can see the whole loop before wiring up your own (policy packaging is step two).

    your first run
    import roborama  # reads ROBORAMA_API_KEY from the environment
    
    run = roborama.run(
        robot="g1-edu-pro@fw2.3",
        environment="kitchen-std@v1.2",
        task="pick_place@v1",
        episodes="auto(ci=0.95, moe=0.03)",
    )
    print(run.result())  # n=612  rate=0.874  ci95=(0.846, 0.898)
  3. Read the result

    The run queues, a cell schedules it, and episodes tick until the margin-of-error target is met — here, n=612:

    n=612  rate=0.874  ci95=(0.846, 0.898)
    

    A rate of 0.874 with a Wilson 95% interval of (0.846, 0.898): defensible in a release review, reproducible from the recorded pins. Watch it live with run.watch() or the events stream.

  4. Pull the artifacts

    Every episode ships video, MCAP telemetry, and a re-runnable replay spec; the run ships a citable verification report.

    import roborama
    
    run = roborama.runs.get("run_8842")
    print(run.episodes[17].video_url)
    run.report(format="pdf")

Where next

  • The full engagement shape: Advanced quickstart — ship a kit, freeze your claim as a Task Spec, verify, and prove it across embodiments in seven calls.
  • Attach your own policy: Policies — container, checkpoint, or endpoint, with contracts validated before any motor moves.
  • Understand the numbers: Runs & statistics.
  • Price a bigger job first: POST /v1/quote — both meters, visible in every quote.
  • Gate your releases: CI gates.