Sign in

v9

latestSwagger 2.02026-07-135252167.7 KB
ImageApi

Get images for a given project iteration or workspace.

This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned

get/projects/{projectId}/images

Path parameters

projectIdstring uuid required

The project id.

Query parameters

iterationIdstring uuid

The iteration id. Defaults to workspace.

tagIdsstring[]

A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.

taggingStatus'All' | 'Tagged' | 'Untagged'

The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.

$filterstring

An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response. The expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators. Here is an example, metadata=key1 eq 'value1' and key2 ne 'value2'.

orderBy'Newest' | 'Oldest'

The ordering. Defaults to newest.

takeinteger

Maximum number of images to return. Defaults to 50, limited to 256.

skipinteger

Number of images to skip before beginning the image batch. Defaults to 0.

Response

OK

idstring uuid

Id of the image.

createdstring date-time

Date the image was created.

widthinteger

Width of the image.

heightinteger

Height of the image.

resizedImageUristring

The URI to the (resized) image used for training. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.

thumbnailUristring

The URI to the thumbnail of the original image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.

originalImageUristring

The URI to the original uploaded image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.

metadataobject nullable

Metadata associated with this image.

Example response

[
  {
    "id": "00000000-0000-0000-0000-000000000000"
  }
]