PHphospho
recording

Play Recording

Play a recorded episode.

post/recording/play

Request

  • The document declares no server URL.
  • Auth
    none required

Request body

dataset_format'lerobot_v2' | 'lerobot_v2.1'

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

dataset_namestring nullable

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

episode_idinteger nullable

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.

episode_pathstring nullable

(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.

interpolation_factorinteger

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

playback_speednumber

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.

replicateboolean

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_serials_to_ignorestring[] nullable

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

Example request

{
  "dataset_name": "example_dataset",
  "episode_id": 0
}

Response

Successful Response

messagestring nullable
status'ok' | 'error'

Changes

No recorded changes to this operation across all 1 revision of this API.