POST
/
recording
/
start
{
  "message": "<string>",
  "status": "ok"
}

Body

application/json

Request to start the recording of an episode.

​
branch_path
string | null

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.

​
cameras_ids_to_record
integer[] | null

List of camera ids to record. If set to None, records all available cameras.

Example:
[0, 1]
​
dataset_name
string | null

Name of the dataset to save the episode in.If None, defaults to the value set in Admin Configuration.

Example:

"example_dataset"

​
episode_format
enum<string> | null

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

Available options:
json,
lerobot_v2
Example:

"lerobot_v2"

​
freq
integer | null

Records steps of the robot at this frequency.If None, defaults to the value set in Admin Configuration.

Example:

30

​
instruction
string | null

A text describing the recorded task. If set to None, defaults to the value set in Admin Configuration.

Example:

"Pick up the orange brick and put it in the black box."

​
robot_serials_to_ignore
string[] | null

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

Example:
["/dev/ttyUSB0"]
​
target_video_size
any[] | null

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

Example:
[320, 240]
​
video_codec
enum<string> | null

Codec to use for the video saving.If None, defaults to the value set in Admin Configuration.

Available options:
avc1,
hev1,
mp4v,
hvc1,
avc3,
av01,
vp09
Example:

"mp4v"

Response

200
application/json
Successful Response

Default response. May contain other fields.

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

Was this page helpful?