POST
/
recording
/
start
{
  "status": "ok"
}

Query Parameters

​
robot_id
integer
default:
0

Body

application/json

Request to start the recording of an episode.

​
dataset_name
string
default:
example_dataset

Name of the dataset to save the episode in.

​
episode_format
enum<string>
default:
lerobot_v2

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.

Available options:
json,
lerobot_v2
​
video_codec
enum<string> | null

Codec to use for the video saving. Defaults to None.

Available options:
avc1,
hev1,
mp4v,
hvc1,
avc3,
av01,
vp09
​
freq
integer
default:
10

Records steps of the robot at this frequency. Defaults to 10.

Response

200
application/json
Successful Response

Default response.

​
status
string
default:
ok
Allowed value: "ok"

Was this page helpful?

Video Feed For CameraStop Recording Episode