PHphospho
recording

Start Recording Episode

Asynchronously start recording an episode in the background. Output format is chosen when stopping the recording.

post/recording/start

Request

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

Request body

add_metadataobject nullable

Passing a dictionnary will store the value in each row of the recorded dataset. The key is the name of the column, and the value is a list. If set to None, no additional metadata is saved.

branch_pathstring nullable

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

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

dataset_namestring nullable

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

enable_rerun_visualizationboolean

Enable rerun

episode_format'json' | 'lerobot_v2' | 'lerobot_v2.1' nullable

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.

freqinteger nullable

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

instructionstring nullable

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

leader_arm_idsstring[] nullable

Serial numbers of the leader arms used during the recording

robot_serials_to_ignorestring[] nullable

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

save_cartesianboolean

Record cartesian positions of the robots as well, this will make your dataset incompatible with lerobot and it only works for robots with simulators. Defaults to False.

video_codec'avc1' | 'hev1' | 'mp4v' | 'hvc1' | 'avc3' | 'av01' | 'vp09' | 'av1' nullable

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

Example request

{
  "add_metadata": {
    "bbox_position": [
      0.5,
      1,
      0,
      0.5
    ]
  },
  "cameras_ids_to_record": [
    0,
    1
  ],
  "dataset_name": "example_dataset",
  "episode_format": "lerobot_v2.1",
  "freq": 30,
  "instruction": "Pick up the orange brick and put it in the black box.",
  "leader_arm_ids": [
    "/dev/ttyUSB0"
  ],
  "robot_serials_to_ignore": [
    "/dev/ttyUSB0"
  ],
  "target_video_size": [
    320,
    240
  ],
  "video_codec": "avc1"
}

Response

Successful Response

messagestring nullable
status'ok' | 'error'

Changes

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