Start Recording Episode
Asynchronously start recording an episode in the background. Output format is chosen when stopping the recording.
Body
Request to start the recording of an episode.
Path to the branch to push the dataset to, in addition to the main branch. If set to None, only push to the main branch. Defaults to None.
List of camera ids to record. If set to None, records all available cameras.
[0, 1]
Name of the dataset to save the episode in.If None, defaults to the value set in Admin Settings.
"example_dataset"
Format to save the episode.
json
is compatible with OpenVLA and stores videos as a series of npy.
lerobot_v2
is compatible with lerobot training..If None, defaults to the value set in Admin Settings.
json
, lerobot_v2
"lerobot_v2"
Records steps of the robot at this frequency.If None, defaults to the value set in Admin Settings.
30
A text describing the recorded task. If set to None, defaults to the value set in Admin Settings.
"Pick up the orange brick and put it in the black box."
List of robot indexes to ignore. If set to None, records all available robots.
[1]
Target video size for the recording, all videos in the dataset should have the same size. If set to None, defaults to the value set in Admin Settings.
[320, 240]
Codec to use for the video saving.If None, defaults to the value set in Admin Settings.
avc1
, hev1
, mp4v
, hvc1
, avc3
, av01
, vp09
"mp4v"
Was this page helpful?