General
Deprecated
The api v1 is deprecated. Please visit api v2 docs page to read more about latest API.
General¶
Projects¶
Datasets¶
GET /datasets¶
Get datasets list
Params:
- projectId - Integer optional
Example:
?projectId=1
Response:
[ { "id": 1, "projectId": 1, "title": "Cats", "size": "4476636", "createdAt": "2018-04-06T13:25:15.994Z", "updatedAt": "2018-04-06T13:25:15.994Z" }, { "id": 2, "projectId": 1, "title": "Dogs", "size": "1715155", "createdAt": "2018-04-06T13:25:15.994Z", "updatedAt": "2018-04-06T13:25:15.994Z" } ]
DELETE /datasets/:datasetId¶
Delete dataset by id
Example:
/datasets/1
Response:
{ success: true }
Images¶
Annotations¶
GET /annotations¶
Get annotations list
Params:
- projectId - Integer
- datasetIds - Integer[], optional
- page - Integer optional
- perPage - Integer (default & max - 1000) optional
Example:
?project=Test+project
Response:
[ { "imageId": 1, "data": { "description": "", "tags": [], "name": "image1", "objects": [ { "classTitle": "Bike", "description": "", "tags": [], "bitmap": null, "points": { "interior": [], "exterior": [ [ 298.0, 252.0 ], [ 565.0, 359.0 ], [ 605.0, 238.0 ], [ 433.0, 156.0 ], [ 298.0, 252.0 ] ] } } ], "size": { "width": 936, "height": 468 } } } ]
Models¶
GET /models¶
Get models list
Params:
- id - Integer[] optional
- page - Integer optional
- perPage - Integer (default & max - 1000) optional
Example:
?id=1
Response:
[ { "id": 1, "title": "test_model", "architectureId": 6, "createdAt": "2018-04-06T13:25:15.994Z", "updatedAt": "2018-04-06T13:25:15.994Z", "path": { "bucket": "some-bucket", "objectName": "models/data/L/m/VM/EtQ8pufPCSSoEAxBQxhbNlKtEEATgErNZRKLbBbdgqrYcwV5okThpHh40WewYEy3v2gvO1PJUtXwwENRwizZNCbjKH53F2gPm57SBej7GM72WB7ZwWouzKSs332a" } } ]
Architectures¶
GET /architectures¶
Get architectures list
Params:
- id - Integer[] optional
- page - Integer optional
- perPage - Integer (default & max - 1000) optional
Example:
?id=1
Response:
[ { "id": 1, "title": "UNet", "description": "The u-net is convolutional network architecture for fast and precise segmentation of images. Up to now it has outperformed the prior best method", "categoryId": 2, "createdAt": "2018-04-06T13:25:15.994Z", "updatedAt": "2018-04-06T13:25:15.994Z", "trainImage": "docker.deepsystems.io/supervisely/train/unet", "inferenceImage": "docker.deepsystems.io/supervisely/train/unet", "deployImage": "docker.deepsystems.io/supervisely/train/unet" } ]