Sign in

v9

latestSwagger 2.02026-07-135252167.7 KB
ImageApi

Add the provided batch of images to the set of training images.

This API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags. If all images are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.

post/projects/{projectId}/images/files

Path parameters

projectIdstring uuid required

The project id.

Request body

tagIdsstring[]
metadataobject nullable

The metadata of image. Limited to 10 key-value pairs per image. The length of key is limited to 128. The length of value is limited to 256.

Example request

{
  "images": [
    {
      "tagIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  ],
  "tagIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Response

OK

isBatchSuccessfulboolean

True if all of the images in the batch were created successfully, otherwise false.

Example response

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