Comment on page

Label sets

Label sets
Create new label set in a dataset
URL
POST https://tools.deepen.ai/api/v2/datasets/{datasetId}/label_sets​
Request
Path parameters
Parameter name
Parameter type
Description
datasetId
string
Dataset id of the dataset
Request body
Property name
Property type
Description
labelSetId
string
Label set id of the new label set
Example body
{
 "labelSetId": "Golden labelset",
}
{
 "labelSetId": "Golden labelset",
}
​
Response
Returns an empty response on successful completion.

Get all label sets in a dataset
URL
GET https://tools.deepen.ai/api/v2/datasets/{datasetId}/label_sets​
Request
Path parameters
Parameter name
Parameter type
Description
datasetId
string
Dataset id of the dataset
Response
Returns a json object ‘additional_label_sets_config’ which contains all the label set ids.

Delete a label set in a dataset
URL
DELETE https://tools.deepen.ai/api/v2/datasets/{datasetId}/label_sets​
Request
Path parameters
Parameter name
Parameter type
Description
datasetId
string
Dataset id of the dataset
Request body
Property name
Property type
Description
label_set_id
string
Label set id of the new label set
Example body
{
 "label_set_id": "Golden labelset",
}
​
Response
Returns an empty response on successful completion.

Copy labels between label sets
URL
POST https://tools.deepen.ai/api/v2/datasets/{datasetId}/copy_labels​
Request
Path parameters
Parameter name
Parameter type
Description
datasetId
string
Dataset id of the dataset
Request body
Property name
Property type
Description
source_label_set
string
Label set id from which labels will be copied
destination_label_set
string
Label set id where labels will get copied
Example body
{
 "source_label_set": "default",
        "destination_label_set": "Golden labelset",
}
​
Response
Returns an empty response on successful completion.


Compare labels between label sets
This returns a comparison of labels count only for the 3D bounding box.
URL
GET https://tools.deepen.ai/api/v2/datasets/{datasetId}/compare_label_sets​
Request
Path parameters
Parameter name
Parameter type
Description
datasetId
string
Dataset id of the dataset
Request body
Property name
Property type
Description
labelSetId
string
Label set id whose labels will be compared
secondLabelSetId
string
Label set id whose labels will be compare
Example body
{
 "labelSetId": "default",
        "secondLabelSetId": "Golden labelset",
}
​
Response
Returns a json object “compared_dict” which contains the comparison result of the two label sets.

Embedded Viewer
URL
GET https://tools.deepen.ai/api/v2/datasets/{datasetId}/embedded_viewers​
Request
Path parameters
Parameter name
Parameter type
Description
datasetId
string
dataset id of the Viewer
Response
Returns a json EmbeddedViewerDataResource object.


URL
POST https://tools.deepen.ai/api/v2/datasets/{datasetId}/embedded_viewers​
Request
Path parameters
Parameter name
Parameter type
Description
datasetId
string
dataset id of the Viewer
Request body
{
 “enable_camera_view”: true,
            “launching_frame_index”: 1,
 “title”:”test123”
}
Response
Returns an empty json object on successful creation of embedded url.



URL
GET https://tools.deepen.ai/api/v2/embedded_viewers/{embeddedViewerid}​
Request
Path parameters
Parameter name
Parameter type
Description
embeddedViewerId
string
Embedded Viewer id of the Viewer
Response
Returns a json EmbeddedViewerDataResource object.

URL

DELETE https://tools.deepen.ai/api/v2/embedded_viewers/{embeddedViewerid}​
Request
Path parameters
Parameter name
Parameter type
Description
embeddedViewerId
string
Embedded Viewer id of the Viewer
Response
Returns an empty json on the deletion of EmbeddedViewerDataResource object.

API Reference - Previous

Download datasets

Next - API Reference

Resources

Last modified 6mo ago

Parameter name	Parameter type	Description
datasetId	string	Dataset id of the dataset

Property name	Property type	Description
labelSetId	string	Label set id of the new label set

Parameter name	Parameter type	Description
datasetId	string	Dataset id of the dataset

Parameter name	Parameter type	Description
datasetId	string	Dataset id of the dataset

Property name	Property type	Description
label_set_id	string	Label set id of the new label set