Export Data
Download machine data to your computer with the Viam CLI or data client API.
Export data with the Viam CLI
To export your synced data using the Viam CLI, first install the Viam CLI and authenticate to Viam.
Then, to export data from the data management service in the cloud:
Navigate to the DATA page in the Viam app.
Below the SEARCH button in the Filters panel, click Copy Export Command to copy the export command to the clipboard.
Run the copied command in a terminal:
viam data export --org-ids=<org-id> --data-type=binary --mime-types=<mime types> --destination=.
This command uses the Viam CLI to download the data locally onto your computer based on the search criteria you select in the Viam app.
By default, the command creates two new directories named
data
andmetadata
in the current directory and downloads the specified data into thedata
folder and metadata, like bounding box information and labels, in JSON format into themetadata
folder. If you want to store the data in a different location, change the specified folder with the--destination
flag.Once the command has finished running and downloading the data, you can view and use the data locally.
Since data is downloaded in parallel, the order is not guaranteed. Sort your folder by filename in order to see them in chronological order.
You can see more information about exporting data in the Viam CLI documentation.
Manage data with the data client API
You can also use the Data Client API to upload and export data to and from the Viam app. This API includes a set of methods for managing data, including export, batch delete, tag, upload, and many more.
Next steps
For a comprehensive tutorial on using data capture and synchronization together with the ML model service, see Capture Data and Train a Model.
Have questions, or want to meet other people working on robots? Join our Community Discord.
If you notice any issues with the documentation, feel free to file an issue or edit this file.
Was this page helpful?
Glad to hear it! If you have any other feedback please let us know:
We're sorry about that. To help us improve, please tell us what we can do better:
Thank you!