Previous page
Next page
General info
| Method | GET /IP address:port/<api_ver>/images |
| Description | The query is used to preview images for the specified classes. You can request images starting from a specific index, and download only a portion of the images (to save bandwidth and speed up work) |
Sample request
GET http://localhost:5000/v1.3/images?task_id=58e6486f44ec5b9cfa59d49011743739e4c37b9b6ecd90cd795f1307ca83fbf2&offset=10&class_names=Bus
where:
| Parameter | Description |
|---|---|
| task_id | A unique identifier of the task (uid), to which the class belongs. It can be obtained using a task list query (see Get the list of tasks) |
| offset | The index of the first image. This value can be either positive or negative. If the offset value is negative, the images starting from the end of the interval will be returned. Example: if offset is -5, the last 5 images will be returned. The limit on the number of images for one class is 1000 |
| class_names | List of class names whose images should be retrieved. If not specified, images of all available classes are returned by default |
Sample response
{
"thumbnails": {
"img1.jpeg":"data:image/jpeg;base64,/9j/4AAQSkZ...2Q==",
...
"imgk.jpeg""data:image/jpeg;base64,/9j/4AAQSkZ...2Q=="
],
"total_count": 100
}
where:
| Parameter | Description |
|---|---|
| thumbnails | An object containing key-value pairs where the key is the image file name (e.g. img1.jpeg) and the value is a Base64 encoded string of the image. Image previews are returned as Base64 encoded strings. |
| total_count | Total number of images in the class(es) that are available for viewing |
Response in case of error:
{ "error": "error description" }