recording

Start Recording

Start recording ROS2 topics.

post/api/recording/start

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

topicsstring[] nullable

Topics to record. If None, the default configuration is used.

task_namestring nullable

Task name. When provided, used as a prefix for the recording directory name.

metadataobject nullable

Pre-registered metadata (key -> value) persisted into recording_meta.json.

Response

Successful Response

output_pathstring required
start_timestring date-time required

Changes

No recorded changes to this operation across all 5 revisions of this API.