Skip to main content
POST
/
recording
/
play
{
  "message": "<string>",
  "status": "ok"
}

Body

application/json

Request to play a recorded episode.

​
dataset_format
enum<string>
default:lerobot_v2.1

Format of the dataset to play. This is used to determine how to read the episode data.

Available options:
lerobot_v2,
lerobot_v2.1
​
dataset_name
string | null

Name of the dataset to play the episode from. If None, defaults to the last dataset recorded.

Examples:

"example_dataset"

​
episode_id
integer | null

ID of the episode to play. If a dataset_name is specified but episode_id is None, plays the last episode recorded of this dataset. If dataset_name is None, this is ignored and plays the last episode recorded.

Examples:

0

​
episode_path
string | null

(Optional) If you recorded your data with LeRobot v2 compatible format, you can directly specifiy the path to the .parquet file of the episode to play. If specified, you don't have to pass a dataset_name or episode_id.

Examples:

"~/phosphobot/lerobot_v2/example_dataset/chunk-000/episode_000000.json"

​
interpolation_factor
integer
default:4

Smoothen the playback by interpolating between frames. 1 means no interpolation, 2 means 1 frame every 2 frames, etc. 4 is the recommended value.

Required range: x >= 1
​
playback_speed
number
default:1

Speed of the playback. 1.0 is normal speed, 0.5 is half speed, 2.0 is double speed. High speed may cause the robot to break.

Required range: x >= 0
​
replicate
boolean
default:true

If False and there are more robots than number of robots in the episode, extra robots will not move. If True, all the extras robots will replicate movements of the robots in the episode.Examples: If there are 4 robots and the episode has 2 robots, if replicate is True, robot 3 and 4 will replicate the movements of robot 1 and 2. If replicate is False, robot 3 and 4 will not move.

​
robot_id

ID of the robot to play the episode on. If None, plays on all robots. If a list, plays on the robots with the given IDs.

Examples:

0

[0, 1]
​
robot_serials_to_ignore
string[] | null

List of robot serial ids to ignore. If set to None, plays on all available robots.

Examples:
["/dev/ttyUSB0"]

Response

Successful Response

Default response. May contain other fields.

​
message
string | null
​
status
enum<string>
default:ok
Available options:
ok,
error
⌘I