Download labels

Download labels
Download all labels
URL 
GET https://tools.deepen.ai/api/v2/datasets/{datasetId}/labels?filter_existing_categories=true&final=true​
Request
Path parameters
Parameter name
Parameter type
Description
datasetId
string
Dataset Id of the dataset
Response
Returns a json with the field ‘all_labels’ that represents an array of all the labels in the dataset.
Example
all_labels: [{'file_id': '20190412_092019_002Img1_338613.pcd', 'label_category_id': 'car', 'label_id': 'car:4', 'label_type': '3d_bbox', 'stage_id': 'QA', 'create_time_millis': 1589965718592, 'label_set_id': 'default', 'labeller_email': '[email protected]', 'sensor_id': 'lidar', 'three_d_bbox': {'cx': 4.664568330379911, 'cy': 6.061948311705668, 'cz': 1.0518338639631983, 'h': 2.25, 'l': 2.25, 'w': 2.25, 'rot_z': 0}, 'update_time_millis': 1589965718592, 'version': 1}]
Download labels by filename
URL
GET  https://tools.deepen.ai/api/v2/datasets/{datasetId}/labels?labels_with_file_ids_order=true&final=true​
Request
Path parameters
Parameter name
Parameter type
Description
datasetId
string
Dataset Id of the dataset
Response
Returns a json with the field ‘labels’ that represents a dictionary of labels and files.
Example
'labels': {'20190412_092019_002Img1_338613.pcd': [{'file_id': '20190412_092019_002Img1_338613.pcd', 'label_category_id': 'car', 'label_id': 'car:4', 'label_type': '3d_bbox', 'stage_id': 'QA', 'create_time_millis': 1589965718592, 'label_set_id': 'default', 'labeller_email': '[email protected]', 'sensor_id': 'lidar', 'three_d_bbox': {'cx': 4.664568330379911, 'cy': 6.061948311705668, 'cz': 1.0518338639631983, 'h': 2.25, 'l': 2.25, 'w': 2.25, 'rot_z': 0}, 'update_time_millis': 1589965718592, 'version': 1}], '20190412_092019_002Img1_338663.pcd': [], '20190412_092019_002Img1_338713.pcd': [], '20190412_092019_002Img1_338763.pcd': [], '20190412_092019_002Img1_338813.pcd': [], '20190412_092019_002Img1_338863.pcd': [], '20190412_092019_002Img1_338913.pcd': [], '20190412_092019_002Img1_338963.pcd': [], '20190412_092019_002Img1_339013.pcd': [], '20190412_092019_002Img1_339062.pcd': []}
Note: Labels can only be downloaded after the completion of labelling.
Import labels
URL
POST https://tools.deepen.ai/api/v2/datasets/{datasetId}/labels?labelSetId={labelSetId}}​
Request
Path parameters
Parameter name
Parameter type
Description
datasetId
string
Dataset Id of the dataset for which the labels need to be imported
labelSetId (Optional)
string
Label Set Id of the label set for which the labels need to be imported
Request body
Property name
Property type
Description
type
string
Type of the file uploaded for labels import. Supported values : “json”
labels
string
Array of objects of type LabelResource
Response
Returns empty response on successful completion
Example
{ "type": "json", "labels": [{ "file_id": "10.pcd", "label_type": "polygon", "sensor_id": "camera_0", "label_category_id": "car", "label_id": "car:5", "polygons": [[[2,3], [5,6], [78, 9]], [[34, 56], [45, 67], [33, 45]]] },{ "file_id": "10.pcd", "label_type": "3d_bbox", "label_category_id": "car", "label_id": "car:5", "three_d_bbox": {"cx": 6.417910191363102, "cy": 37.40165669339892, "cz": -2.026788515715022, "rot_z": -1.4502365175856688, "h": 1.6082608226905268, "l": 4.062483053079639, "w": 1.8871934665515997} }] }
​

API Reference - Previous

Import 3D labels for a dataset

Next - API Reference

Labeling profiles

Last modified 1mo ago

Export as PDF

Copy link

Contents

Download labels

Import labels