Sign in

v9

latestSwagger 2.02026-07-135252167.7 KB
ImageApi

Get images by id for a given project iteration.

This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the current workspace is used.

get/projects/{projectId}/images/id

Path parameters

projectIdstring uuid required

The project id.

Query parameters

imageIdsstring[]

The list of image ids to retrieve. Limited to 256.

iterationIdstring uuid

The iteration id. Defaults to workspace.

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"
  }
]