This API accepts a batch of image regions, and optionally tags, to update existing images with region information.
There is a limit of 64 entries in the batch.
Format - uuid. The project id.
Batch of image regions which include a tag and bounding box. Limited to 64.
API key.
{
"regions": [
{
"imageId": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateBatch>
<regions>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageRegionCreateBatch>
<ImageRegionCreateBatch>
<regions>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageRegionCreateBatch>
OK
{
"created": [
{
"imageId": "string",
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"duplicated": [
{
"imageId": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"exceeded": [
{
"imageId": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateSummary>
<created>
<imageId>string</imageId>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
<ImageRegionCreateSummary>
<created>
<imageId>string</imageId>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API accepts body content as multipart/form-data and application/octet-stream. When using multipart
multiple image files can be sent at once, with a maximum of 64 files
Format - uuid. The project id.
The tags ids with which to tag each image. Limited to 20.
API key.
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags.
Format - uuid. The project id.
The batch of image files to add. Limited to 64 images and 20 tags per batch.
API key.
{
"images": [
{
"name": "string",
"contents": "string",
"tagIds": [
"string"
],
"regions": [
{
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"string"
]
}
<ImageFileCreateBatch>
<images>
<name>string</name>
<contents>string</contents>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageFileCreateBatch>
<ImageFileCreateBatch>
<images>
<name>string</name>
<contents>string</contents>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageFileCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags.
Format - uuid. The project id.
Image and tag ids. Limited to 64 images and 20 tags per batch.
API key.
{
"images": [
{
"id": "string",
"tagIds": [
"string"
],
"regions": [
{
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"string"
]
}
<ImageIdCreateBatch>
<images>
<id>string</id>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageIdCreateBatch>
<ImageIdCreateBatch>
<images>
<id>string</id>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageIdCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API accepts a batch of urls, and optionally tags, to create images. There is a limit of 64 images and 20 tags.
Format - uuid. The project id.
Image urls and tag ids. Limited to 64 images and 20 tags per batch.
API key.
{
"images": [
{
"url": "string",
"tagIds": [
"string"
],
"regions": [
{
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"string"
]
}
<ImageUrlCreateBatch>
<images>
<url>string</url>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageUrlCreateBatch>
<ImageUrlCreateBatch>
<images>
<url>string</url>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageUrlCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Associate a set of images with a set of tags.
Format - uuid. The project id.
Batch of image tags. Limited to 128 tags per batch.
API key.
{
"tags": [
{
"imageId": "string",
"tagId": "string"
}
]
}
<ImageTagCreateBatch>
<tags>
<imageId>string</imageId>
<tagId>string</tagId>
</tags>
</ImageTagCreateBatch>
<ImageTagCreateBatch>
<tags>
<imageId>string</imageId>
<tagId>string</tagId>
</tags>
</ImageTagCreateBatch>
OK
{
"created": [
{
"imageId": "string",
"tagId": "string"
}
],
"duplicated": [
{
"imageId": "string",
"tagId": "string"
}
],
"exceeded": [
{
"imageId": "string",
"tagId": "string"
}
]
}
<ImageTagCreateSummary>
<created>
<imageId>string</imageId>
<tagId>string</tagId>
</created>
<duplicated>
<imageId>string</imageId>
<tagId>string</tagId>
</duplicated>
<exceeded>
<imageId>string</imageId>
<tagId>string</tagId>
</exceeded>
</ImageTagCreateSummary>
<ImageTagCreateSummary>
<created>
<imageId>string</imageId>
<tagId>string</tagId>
</created>
<duplicated>
<imageId>string</imageId>
<tagId>string</tagId>
</duplicated>
<exceeded>
<imageId>string</imageId>
<tagId>string</tagId>
</exceeded>
</ImageTagCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Create a project.
The description of the project.
Format - uuid. The id of the domain to use for this project. Defaults to General.
The type of classifier to create for this project.
List of platforms the trained model is intending exporting to.
Name of the project.
API key.
OK
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
]
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true
}
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Create a tag for the project.
Format - uuid. The project id.
Optional description for the tag.
Optional type for the tag.
The tag name.
API key.
OK
{
"id": "string",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Delete a set of image regions.
Format - uuid. The project id.
Regions to delete. Limited to 64.
API key.
No Content
Error response
Delete images from the set of training images.
Format - uuid. The project id.
Ids of the images to be deleted. Limited to 256 images per batch.
API key.
No Content
Error response
Remove a set of tags from a set of images.
Format - uuid. The project id.
Image ids. Limited to 64 images.
Tags to be deleted from the specified images. Limited to 20 tags.
API key.
No Content
Error response
Delete a specific iteration of a project.
Format - uuid. The project id.
Format - uuid. The iteration id.
API key.
No Content
Error response
Delete a set of predicted images and their associated prediction results.
Format - uuid. The project id.
The prediction ids. Limited to 64.
API key.
No Content
Error response
Delete a specific project.
Format - uuid. The project id.
API key.
No Content
Error response
Delete a tag from the project.
Format - uuid. The project id.
Format - uuid. Id of the tag to be deleted.
API key.
No Content
Error response
Export a trained iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
The flavor of the target platform.
The target platform.
API key.
OK
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
<Export>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</Export>
<Export>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</Export>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get information about a specific domain.
Format - uuid. The id of the domain to get information about.
API key.
OK
{
"id": "string",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
<Domain>
<id>string</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</Domain>
<Domain>
<id>string</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</Domain>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a list of the available domains.
API key.
OK
[
{
"id": "string",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
]
<DomainArray>
<id>string</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</DomainArray>
<DomainArray>
<id>string</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</DomainArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get the list of exports for a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
API key.
OK
[
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
]
<ExportArray>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</ExportArray>
<ExportArray>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</ExportArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images to count. Defaults to all tags when null.
API key.
OK
0
<ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200ApplicationXmlResponse>0</ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200ApplicationXmlResponse>
<ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200TextXmlResponse>0</ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
API key.
OK
[
{
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
],
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
]
<ImagePerformanceArray>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<imageUri>string</imageUri>
<thumbnailUri>string</thumbnailUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImagePerformanceArray>
<ImagePerformanceArray>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<imageUri>string</imageUri>
<thumbnailUri>string</thumbnailUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImagePerformanceArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.
Format - uuid. The project id.
Format - uuid. The image id.
API key.
OK
{
"projectId": "string",
"imageId": "string",
"proposals": [
{
"confidence": 0.0,
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
Error response
{
"code": "NoError",
"message": "string"
}
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.
Format - uuid. The project id.
The list of image ids to retrieve. Limited to 256.
Format - uuid. The iteration id. Defaults to workspace.
API key.
OK
[
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
]
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a specific iteration.
Format - uuid. The id of the project the iteration belongs to.
Format - uuid. The id of the iteration to get.
API key.
OK
{
"id": "string",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "string",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get detailed performance information about an iteration.
Format - uuid. The id of the project the iteration belongs to.
Format - uuid. The id of the iteration to get.
Format - float. The threshold used to determine true predictions.
Format - float. If applicable, the bounding box overlap threshold used to determine true predictions.
API key.
OK
{
"perTagPerformance": [
{
"id": "string",
"name": "string",
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
],
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
<IterationPerformance>
<perTagPerformance>
<id>string</id>
<name>string</name>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</perTagPerformance>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</IterationPerformance>
<IterationPerformance>
<perTagPerformance>
<id>string</id>
<name>string</name>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</perTagPerformance>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</IterationPerformance>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get iterations for the project.
Format - uuid. The project id.
API key.
OK
[
{
"id": "string",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "string",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
]
<IterationArray>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</IterationArray>
<IterationArray>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</IterationArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a specific project.
Format - uuid. The id of the project to get.
API key.
OK
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
]
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true
}
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get your projects.
API key.
OK
[
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
]
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true
}
]
<ProjectArray>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</ProjectArray>
<ProjectArray>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</ProjectArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get information about a specific tag.
Format - uuid. The project this tag belongs to.
Format - uuid. The tag id.
Format - uuid. The iteration to retrieve this tag from. Optional, defaults to current training set.
API key.
OK
{
"id": "string",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images to count. Defaults to all tags when null.
API key.
OK
0
<ProjectsProjectIdImagesTaggedCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesTaggedCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesTaggedCountGet200TextXmlResponse>0</ProjectsProjectIdImagesTaggedCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
API key.
OK
[
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
]
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get the tags for a given project and iteration.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
API key.
OK
[
{
"id": "string",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
]
<TagArray>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</TagArray>
<TagArray>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</TagArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the
current workspace is used.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
API key.
OK
0
<ProjectsProjectIdImagesUntaggedCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesUntaggedCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesUntaggedCountGet200TextXmlResponse>0</ProjectsProjectIdImagesUntaggedCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
API key.
OK
[
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
]
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Publish a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
The name to give the published iteration.
The id of the prediction resource to publish to.
API key.
OK
True
<ProjectsProjectIdIterationsIterationIdPublishPost200ApplicationXmlResponse>true</ProjectsProjectIdIterationsIterationIdPublishPost200ApplicationXmlResponse>
<ProjectsProjectIdIterationsIterationIdPublishPost200TextXmlResponse>true</ProjectsProjectIdIterationsIterationIdPublishPost200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get images that were sent to your prediction endpoint.
Format - uuid. The project id.
Parameters used to query the predictions. Limited to combining 2 tags.
API key.
{
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "string",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "string",
"startTime": "string",
"endTime": "string",
"application": "string"
}
<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>
<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>
OK
{
"token": {
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "string",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "string",
"startTime": "string",
"endTime": "string",
"application": "string"
},
"results": [
{
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"domain": "string",
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
]
}
<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>string</domain>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</results>
</PredictionQueryResult>
<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>string</domain>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</results>
</PredictionQueryResult>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Quick test an image.
Format - uuid. The project id.
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
API key.
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
OK
{
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
<ImagePrediction>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</ImagePrediction>
<ImagePrediction>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</ImagePrediction>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Quick test an image url.
Format - uuid. The project to evaluate against.
An ImageUrl that contains the url of the image to be evaluated.
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
API key.
{
"url": "string"
}
<ImageUrl>
<url>string</url>
</ImageUrl>
<ImageUrl>
<url>string</url>
</ImageUrl>
OK
{
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
<ImagePrediction>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</ImagePrediction>
<ImagePrediction>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</ImagePrediction>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Queues project for training.
Format - uuid. The project id.
The type of training to use to train the project (default: Regular).
Format - int32. The number of hours reserved as budget for training (if applicable).
Whether to force train even if dataset and configuration does not change (default: false).
The email address to send notification to when training finishes (default: null).
API key.
OK
{
"id": "string",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "string",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Unpublish a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
API key.
No Content
Error response
Update a specific iteration.
Format - uuid. Project id.
Format - uuid. Iteration id.
The updated iteration model.
API key.
{
"id": "string",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "string",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
OK
{
"id": "string",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "string",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a specific project.
Format - uuid. The id of the project to update.
The updated project model.
API key.
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
]
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true
}
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
OK
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
]
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true
}
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a tag.
Format - uuid. The project id.
Format - uuid. The id of the target tag.
The updated tag model.
API key.
{
"id": "string",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
OK
{
"id": "string",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API accepts a batch of image regions, and optionally tags, to update existing images with region information.
There is a limit of 64 entries in the batch.
Format - uuid. The project id.
Batch of image regions which include a tag and bounding box. Limited to 64.
API key.
{
"regions": [
{
"imageId": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateBatch>
<regions>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageRegionCreateBatch>
<ImageRegionCreateBatch>
<regions>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageRegionCreateBatch>
OK
{
"created": [
{
"imageId": "string",
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"duplicated": [
{
"imageId": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"exceeded": [
{
"imageId": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateSummary>
<created>
<imageId>string</imageId>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
<ImageRegionCreateSummary>
<created>
<imageId>string</imageId>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>string</imageId>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API accepts body content as multipart/form-data and application/octet-stream. When using multipart
multiple image files can be sent at once, with a maximum of 64 files
Format - uuid. The project id.
The tags ids with which to tag each image. Limited to 20.
API key.
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags.
Format - uuid. The project id.
The batch of image files to add. Limited to 64 images and 20 tags per batch.
API key.
{
"images": [
{
"name": "string",
"contents": "string",
"tagIds": [
"string"
],
"regions": [
{
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"string"
]
}
<ImageFileCreateBatch>
<images>
<name>string</name>
<contents>string</contents>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageFileCreateBatch>
<ImageFileCreateBatch>
<images>
<name>string</name>
<contents>string</contents>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageFileCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags.
Format - uuid. The project id.
Image and tag ids. Limited to 64 images and 20 tags per batch.
API key.
{
"images": [
{
"id": "string",
"tagIds": [
"string"
],
"regions": [
{
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"string"
]
}
<ImageIdCreateBatch>
<images>
<id>string</id>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageIdCreateBatch>
<ImageIdCreateBatch>
<images>
<id>string</id>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageIdCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API accepts a batch of urls, and optionally tags, to create images. There is a limit of 64 images and 20 tags.
Format - uuid. The project id.
Image urls and tag ids. Limited to 64 images and 20 tags per batch.
API key.
{
"images": [
{
"url": "string",
"tagIds": [
"string"
],
"regions": [
{
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"string"
]
}
<ImageUrlCreateBatch>
<images>
<url>string</url>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageUrlCreateBatch>
<ImageUrlCreateBatch>
<images>
<url>string</url>
<tagIds>string</tagIds>
<regions>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>string</tagIds>
</ImageUrlCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Associate a set of images with a set of tags.
Format - uuid. The project id.
Batch of image tags. Limited to 128 tags per batch.
API key.
{
"tags": [
{
"imageId": "string",
"tagId": "string"
}
]
}
<ImageTagCreateBatch>
<tags>
<imageId>string</imageId>
<tagId>string</tagId>
</tags>
</ImageTagCreateBatch>
<ImageTagCreateBatch>
<tags>
<imageId>string</imageId>
<tagId>string</tagId>
</tags>
</ImageTagCreateBatch>
OK
{
"created": [
{
"imageId": "string",
"tagId": "string"
}
],
"duplicated": [
{
"imageId": "string",
"tagId": "string"
}
],
"exceeded": [
{
"imageId": "string",
"tagId": "string"
}
]
}
<ImageTagCreateSummary>
<created>
<imageId>string</imageId>
<tagId>string</tagId>
</created>
<duplicated>
<imageId>string</imageId>
<tagId>string</tagId>
</duplicated>
<exceeded>
<imageId>string</imageId>
<tagId>string</tagId>
</exceeded>
</ImageTagCreateSummary>
<ImageTagCreateSummary>
<created>
<imageId>string</imageId>
<tagId>string</tagId>
</created>
<duplicated>
<imageId>string</imageId>
<tagId>string</tagId>
</duplicated>
<exceeded>
<imageId>string</imageId>
<tagId>string</tagId>
</exceeded>
</ImageTagCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Create a project.
The description of the project.
Format - uuid. The id of the domain to use for this project. Defaults to General.
The type of classifier to create for this project.
List of platforms the trained model is intending exporting to.
Name of the project.
API key.
OK
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
]
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true
}
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Create a tag for the project.
Format - uuid. The project id.
Optional description for the tag.
Optional type for the tag.
The tag name.
API key.
OK
{
"id": "string",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Delete a set of image regions.
Format - uuid. The project id.
Regions to delete. Limited to 64.
API key.
No Content
Error response
Delete images from the set of training images.
Format - uuid. The project id.
Ids of the images to be deleted. Limited to 256 images per batch.
API key.
No Content
Error response
Remove a set of tags from a set of images.
Format - uuid. The project id.
Image ids. Limited to 64 images.
Tags to be deleted from the specified images. Limited to 20 tags.
API key.
No Content
Error response
Delete a specific iteration of a project.
Format - uuid. The project id.
Format - uuid. The iteration id.
API key.
No Content
Error response
Delete a set of predicted images and their associated prediction results.
Format - uuid. The project id.
The prediction ids. Limited to 64.
API key.
No Content
Error response
Delete a specific project.
Format - uuid. The project id.
API key.
No Content
Error response
Delete a tag from the project.
Format - uuid. The project id.
Format - uuid. Id of the tag to be deleted.
API key.
No Content
Error response
Export a trained iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
The flavor of the target platform.
The target platform.
API key.
OK
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
<Export>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</Export>
<Export>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</Export>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get information about a specific domain.
Format - uuid. The id of the domain to get information about.
API key.
OK
{
"id": "string",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
<Domain>
<id>string</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</Domain>
<Domain>
<id>string</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</Domain>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a list of the available domains.
API key.
OK
[
{
"id": "string",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
]
<DomainArray>
<id>string</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</DomainArray>
<DomainArray>
<id>string</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</DomainArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get the list of exports for a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
API key.
OK
[
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
]
<ExportArray>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</ExportArray>
<ExportArray>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</ExportArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images to count. Defaults to all tags when null.
API key.
OK
0
<ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200ApplicationXmlResponse>0</ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200ApplicationXmlResponse>
<ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200TextXmlResponse>0</ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
API key.
OK
[
{
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
],
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
]
<ImagePerformanceArray>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<imageUri>string</imageUri>
<thumbnailUri>string</thumbnailUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImagePerformanceArray>
<ImagePerformanceArray>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<imageUri>string</imageUri>
<thumbnailUri>string</thumbnailUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImagePerformanceArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.
Format - uuid. The project id.
Format - uuid. The image id.
API key.
OK
{
"projectId": "string",
"imageId": "string",
"proposals": [
{
"confidence": 0.0,
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
Error response
{
"code": "NoError",
"message": "string"
}
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.
Format - uuid. The project id.
The list of image ids to retrieve. Limited to 256.
Format - uuid. The iteration id. Defaults to workspace.
API key.
OK
[
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
]
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a specific iteration.
Format - uuid. The id of the project the iteration belongs to.
Format - uuid. The id of the iteration to get.
API key.
OK
{
"id": "string",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "string",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get detailed performance information about an iteration.
Format - uuid. The id of the project the iteration belongs to.
Format - uuid. The id of the iteration to get.
Format - float. The threshold used to determine true predictions.
Format - float. If applicable, the bounding box overlap threshold used to determine true predictions.
API key.
OK
{
"perTagPerformance": [
{
"id": "string",
"name": "string",
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
],
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
<IterationPerformance>
<perTagPerformance>
<id>string</id>
<name>string</name>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</perTagPerformance>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</IterationPerformance>
<IterationPerformance>
<perTagPerformance>
<id>string</id>
<name>string</name>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</perTagPerformance>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</IterationPerformance>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get iterations for the project.
Format - uuid. The project id.
API key.
OK
[
{
"id": "string",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "string",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
]
<IterationArray>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</IterationArray>
<IterationArray>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</IterationArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a specific project.
Format - uuid. The id of the project to get.
API key.
OK
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
]
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true
}
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get your projects.
API key.
OK
[
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
]
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true
}
]
<ProjectArray>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</ProjectArray>
<ProjectArray>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</ProjectArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get information about a specific tag.
Format - uuid. The project this tag belongs to.
Format - uuid. The tag id.
Format - uuid. The iteration to retrieve this tag from. Optional, defaults to current training set.
API key.
OK
{
"id": "string",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images to count. Defaults to all tags when null.
API key.
OK
0
<ProjectsProjectIdImagesTaggedCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesTaggedCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesTaggedCountGet200TextXmlResponse>0</ProjectsProjectIdImagesTaggedCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
API key.
OK
[
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
]
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get the tags for a given project and iteration.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
API key.
OK
[
{
"id": "string",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
]
<TagArray>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</TagArray>
<TagArray>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</TagArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the
current workspace is used.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
API key.
OK
0
<ProjectsProjectIdImagesUntaggedCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesUntaggedCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesUntaggedCountGet200TextXmlResponse>0</ProjectsProjectIdImagesUntaggedCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
API key.
OK
[
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
]
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
<ImageArray>
<id>string</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>string</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>string</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>string</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Publish a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
The name to give the published iteration.
The id of the prediction resource to publish to.
API key.
OK
True
<ProjectsProjectIdIterationsIterationIdPublishPost200ApplicationXmlResponse>true</ProjectsProjectIdIterationsIterationIdPublishPost200ApplicationXmlResponse>
<ProjectsProjectIdIterationsIterationIdPublishPost200TextXmlResponse>true</ProjectsProjectIdIterationsIterationIdPublishPost200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get images that were sent to your prediction endpoint.
Format - uuid. The project id.
Parameters used to query the predictions. Limited to combining 2 tags.
API key.
{
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "string",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "string",
"startTime": "string",
"endTime": "string",
"application": "string"
}
<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>
<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>
OK
{
"token": {
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "string",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "string",
"startTime": "string",
"endTime": "string",
"application": "string"
},
"results": [
{
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"domain": "string",
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
]
}
<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>string</domain>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</results>
</PredictionQueryResult>
<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>string</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>string</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>string</domain>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</results>
</PredictionQueryResult>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Quick test an image.
Format - uuid. The project id.
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
API key.
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
OK
{
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
<ImagePrediction>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</ImagePrediction>
<ImagePrediction>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</ImagePrediction>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Quick test an image url.
Format - uuid. The project to evaluate against.
An ImageUrl that contains the url of the image to be evaluated.
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
API key.
{
"url": "string"
}
<ImageUrl>
<url>string</url>
</ImageUrl>
<ImageUrl>
<url>string</url>
</ImageUrl>
OK
{
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
<ImagePrediction>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</ImagePrediction>
<ImagePrediction>
<id>string</id>
<project>string</project>
<iteration>string</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>string</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</predictions>
</ImagePrediction>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Queues project for training.
Format - uuid. The project id.
The type of training to use to train the project (default: Regular).
Format - int32. The number of hours reserved as budget for training (if applicable).
Whether to force train even if dataset and configuration does not change (default: false).
The email address to send notification to when training finishes (default: null).
API key.
OK
{
"id": "string",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "string",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Unpublish a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
API key.
No Content
Error response
Update a specific iteration.
Format - uuid. Project id.
Format - uuid. Iteration id.
The updated iteration model.
API key.
{
"id": "string",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "string",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
OK
{
"id": "string",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "string",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>string</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>string</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a specific project.
Format - uuid. The id of the project to update.
The updated project model.
API key.
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
]
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true
}
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
OK
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
]
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true
}
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
<Project>
<id>string</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>string</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a tag.
Format - uuid. The project id.
Format - uuid. The id of the target tag.
The updated tag model.
API key.
{
"id": "string",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
OK
{
"id": "string",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>string</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>