Microsoft Azure Custom Vision Training Client is a tool that allows users to train custom image recognition models for their specific use case. By providing a set of labeled images, users can create and fine-tune a machine learning model that can accurately classify and identify objects within images. The Training Client offers a user-friendly interface that guides users through the process of uploading data, labeling images, and training the model.
swagger: '2.0'
info:
version: '3.3'
title: Microsoft Azure Custom Vision Training Client
host: southcentralus.api.cognitive.microsoft.com
basePath: /customvision/v3.3/training
schemes:
- https
paths:
/domains:
get:
tags:
- DomainsApi
summary: 'Microsoft Azure Get A List Of The Available Domains'
operationId: microsoftAzureGetdomains
consumes: []
produces:
- application/json
- application/xml
- text/xml
parameters: []
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Domain'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful GetDomains request:
$ref: ./examples/GetDomains.json
description: Needs a more full description created.
/domains/{domainId}:
get:
tags:
- DomainsApi
summary: 'Microsoft Azure Get Information About A Specific Domain'
operationId: microsoftAzureGetdomain
consumes: []
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: domainId
in: path
description: The id of the domain to get information about.
required: true
type: string
format: uuid
x-nullable: false
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Domain'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful GetDomain request:
$ref: ./examples/GetDomain.json
description: Needs a more full description created.
/projects:
get:
tags:
- ProjectApi
summary: 'Microsoft Azure Get Your Projects'
operationId: microsoftAzureGetprojects
consumes: []
produces:
- application/json
- application/xml
- text/xml
parameters: []
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Project'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful GetProjects request:
$ref: ./examples/GetProjects.json
description: Needs a more full description created.
post:
tags:
- ProjectApi
summary: 'Microsoft Azure Create A Project'
operationId: microsoftAzureCreateproject
consumes: []
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: name
in: query
description: Name of the project.
required: true
type: string
- name: description
in: query
description: The description of the project.
required: false
type: string
- name: domainId
in: query
description: The id of the domain to use for this project. Defaults to General.
required: false
type: string
format: uuid
- name: classificationType
in: query
description: The type of classifier to create for this project.
required: false
type: string
enum:
- Multiclass
- Multilabel
- name: targetExportPlatforms
in: query
description: List of platforms the trained model is intending exporting to.
required: false
type: array
items:
type: string
enum:
- CoreML
- TensorFlow
- DockerFile
- ONNX
- VAIDK
collectionFormat: csv
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Project'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful CreateProject request:
$ref: ./examples/CreateProject.json
description: Needs a more full description created.
/projects/{projectId}:
get:
tags:
- ProjectApi
summary: 'Microsoft Azure Get A Specific Project'
operationId: microsoftAzureGetproject
consumes: []
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The id of the project to get.
required: true
type: string
format: uuid
x-nullable: false
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Project'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful GetProject request:
$ref: ./examples/GetProject.json
description: Needs a more full description created.
delete:
tags:
- ProjectApi
summary: 'Microsoft Azure Delete A Specific Project'
operationId: microsoftAzureDeleteproject
consumes: []
produces: []
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
responses:
'204':
description: No Content
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful DeleteProject request:
$ref: ./examples/DeleteProject.json
description: Needs a more full description created.
patch:
tags:
- ProjectApi
summary: 'Microsoft Azure Update A Specific Project'
operationId: microsoftAzureUpdateproject
consumes:
- application/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The id of the project to update.
required: true
type: string
format: uuid
x-nullable: false
- name: updatedProject
in: body
description: The updated project model.
required: true
schema:
$ref: '#/definitions/Project'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Project'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful UpdateProject request:
$ref: ./examples/UpdateProject.json
description: Needs a more full description created.
/projects/{projectId}/artifacts:
get:
tags:
- ProjectApi
summary: >-
Microsoft Azure Get Artifact Content From Blob Storage, Based On Artifact Relative Path In The Blob
operationId: microsoftAzureGetartifact
consumes: []
produces:
- application/octet-stream
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: path
in: query
description: The relative path for artifact.
required: true
type: string
responses:
'200':
description: OK
schema:
type: file
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful GetArtifact request:
$ref: ./examples/GetArtifact.json
description: Needs a more full description created.
/projects/{projectId}/export:
get:
tags:
- ProjectApi
summary: 'Microsoft Azure Exports A Project'
operationId: microsoftAzureExportproject
consumes: []
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id of the project to export.
required: true
type: string
format: uuid
x-nullable: false
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProjectExport'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful ExportProject request:
$ref: ./examples/ExportProject.json
description: Needs a more full description created.
/projects/{projectId}/images:
get:
tags:
- ImageApi
summary: 'Microsoft Azure Get Images For A Given Project Iteration Or Workspace'
description: >-
This API supports batching and range selection. By default it will only
return first 50 images matching images.<br>Use the {take} and {skip}
parameters to control how many images to return in a given batch.<br>The
filtering is on an and/or relationship. For example, if the provided tag
ids are for the "Dog" and<br>"Cat" tags, then only images tagged with
Dog and/or Cat will be returned
operationId: microsoftAzureGetimages
consumes: []
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: iterationId
in: query
description: The iteration id. Defaults to workspace.
required: false
type: string
format: uuid
- name: tagIds
in: query
description: >-
A list of tags ids to filter the images. Defaults to all tagged
images when null. Limited to 20.
required: false
type: array
items:
type: string
format: uuid
x-nullable: false
collectionFormat: csv
maxItems: 20
minItems: 0
- name: taggingStatus
in: query
description: >-
The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'.
Defaults to 'All'.
required: false
type: string
enum:
- All
- Tagged
- Untagged
- name: $filter
in: query
description: "An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response.\r\nThe expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators.\r\nHere is an example, metadata=key1 eq 'value1' and key2 ne 'value2'."
required: false
type: string
- name: orderBy
in: query
description: The ordering. Defaults to newest.
required: false
type: string
enum:
- Newest
- Oldest
- name: take
in: query
description: Maximum number of images to return. Defaults to 50, limited to 256.
required: false
type: integer
format: int32
default: 50
maximum: 256
minimum: 0
- name: skip
in: query
description: >-
Number of images to skip before beginning the image batch. Defaults
to 0.
required: false
type: integer
format: int32
default: 0
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Image'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful GetImages request:
$ref: ./examples/GetImages.json
post:
tags:
- ImageApi
summary: 'Microsoft Azure Add The Provided Images To The Set Of Training Images'
description: >-
This API accepts body content as multipart/form-data and
application/octet-stream. When using multipart<br>multiple image files
can be sent at once, with a maximum of 64 files.<br>If all images are
successful created, 200(OK) status code will be returned.<br>Otherwise,
207 (Multi-Status) status code will be returned and detail status for
each image will be listed in the response payload.
operationId: microsoftAzureCreateimagesfromdata
consumes:
- multipart/form-data
- application/octet-stream
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: tagIds
in: query
description: The tags ids with which to tag each image. Limited to 20.
required: false
type: array
items:
type: string
format: uuid
x-nullable: false
collectionFormat: csv
maxItems: 20
minItems: 0
- name: imageData
in: formData
description: >-
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP.
Supports images up to 6MB.
required: true
type: file
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageCreateSummary'
'207':
description: '207'
schema:
$ref: '#/definitions/ImageCreateSummary'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful CreateImagesFromData request:
$ref: ./examples/CreateImagesFromData.json
delete:
tags:
- ImageApi
summary: 'Microsoft Azure Delete Images From The Set Of Training Images'
operationId: microsoftAzureDeleteimages
consumes: []
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: imageIds
in: query
description: Ids of the images to be deleted. Limited to 256 images per batch.
required: false
type: array
items:
type: string
format: uuid
x-nullable: false
collectionFormat: csv
maxItems: 256
minItems: 0
- name: allImages
in: query
description: >-
Flag to specify delete all images, specify this flag or a list of
images. Using this flag will return a 202 response to indicate the
images are being deleted.
required: false
type: boolean
- name: allIterations
in: query
description: >-
Removes these images from all iterations, not just the current
workspace. Using this flag will return a 202 response to indicate
the images are being deleted.
required: false
type: boolean
responses:
'202':
description: Accepted
'204':
description: No Content
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful DeleteImages request:
$ref: ./examples/DeleteImages.json
description: Needs a more full description created.
/projects/{projectId}/images/{imageId}/regionproposals:
post:
tags:
- ImageRegionProposalApi
summary: >-
Microsoft Azure Get Region Proposals For An Image Returns Empty Array If No Proposals Are Found
description: >-
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.
operationId: microsoftAzureGetimageregionproposals
consumes: []
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: imageId
in: path
description: The image id.
required: true
type: string
format: uuid
x-nullable: false
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageRegionProposal'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful GetImageRegionProposals request:
$ref: ./examples/GetImageRegionProposals.json
/projects/{projectId}/images/count:
get:
tags:
- ImageApi
summary: 'Microsoft Azure Get The Number Of Images'
description: >-
The filtering is on an and/or relationship. For example, if the provided
tag ids are for the "Dog" and<br>"Cat" tags, then only images tagged
with Dog and/or Cat will be returned
operationId: microsoftAzureGetimagecount
consumes: []
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: iterationId
in: query
description: The iteration id. Defaults to workspace.
required: false
type: string
format: uuid
- name: taggingStatus
in: query
description: >-
The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'.
Defaults to 'All'.
required: false
type: string
enum:
- All
- Tagged
- Untagged
- name: $filter
in: query
description: "An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response.\r\nThe expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators.\r\nHere is an example, metadata=key1 eq 'value1' and key2 ne 'value2'."
required: false
type: string
- name: tagIds
in: query
description: >-
A list of tags ids to filter the images to count. Defaults to all
tags when null.
required: false
type: array
items:
type: string
format: uuid
x-nullable: false
collectionFormat: csv
responses:
'200':
description: OK
schema:
format: int32
type: integer
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful GetImageCount request:
$ref: ./examples/GetImageCount.json
/projects/{projectId}/images/files:
post:
tags:
- ImageApi
summary: 'Microsoft Azure Add The Provided Batch Of Images To The Set Of Training Images'
description: >-
This API accepts a batch of files, and optionally tags, to create
images. There is a limit of 64 images and 20 tags.<br>If all images are
successful created, 200(OK) status code will be returned.<br>Otherwise,
207 (Multi-Status) status code will be returned and detail status for
each image will be listed in the response payload.
operationId: microsoftAzureCreateimagesfromfiles
consumes:
- application/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: batch
in: body
description: >-
The batch of image files to add. Limited to 64 images and 20 tags
per batch.
required: true
schema:
$ref: '#/definitions/ImageFileCreateBatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageCreateSummary'
'207':
description: '207'
schema:
$ref: '#/definitions/ImageCreateSummary'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful CreateImagesFromFiles request:
$ref: ./examples/CreateImagesFromFiles.json
/projects/{projectId}/images/id:
get:
tags:
- ImageApi
summary: 'Microsoft Azure Get Images By Id For A Given Project Iteration'
description: >-
This API will return a set of Images for the specified tags and
optionally iteration. If no iteration is specified the<br>current
workspace is used.
operationId: microsoftAzureGetimagesbyids
consumes: []
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: imageIds
in: query
description: The list of image ids to retrieve. Limited to 256.
required: false
type: array
items:
type: string
format: uuid
x-nullable: false
collectionFormat: csv
maxItems: 256
minItems: 0
- name: iterationId
in: query
description: The iteration id. Defaults to workspace.
required: false
type: string
format: uuid
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Image'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful GetImagesByIds request:
$ref: ./examples/GetImagesByIds.json
/projects/{projectId}/images/metadata:
post:
tags:
- ImageApi
summary: 'Microsoft Azure Update Metadata Of Images'
description: >-
This API accepts a batch of image Ids, and metadata, to update images.
There is a limit of 64 images.
operationId: microsoftAzureUpdateimagemetadata
consumes:
- application/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: imageIds
in: query
description: The list of image ids to update. Limited to 64.
required: true
type: array
items:
type: string
format: uuid
x-nullable: false
collectionFormat: csv
maxItems: 256
minItems: 0
- name: metadata
in: body
description: >-
The metadata to be updated to the specified images. Limited to 50
key-value pairs per image. The length of key is limited to 256. The
length of value is limited to 512.
required: true
schema:
type: object
additionalProperties:
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageMetadataUpdateSummary'
'207':
description: '207'
schema:
$ref: '#/definitions/ImageMetadataUpdateSummary'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful UpdateImageMetadata request:
$ref: ./examples/UpdateImageMetadata.json
/projects/{projectId}/images/predictions:
post:
tags:
- ImageApi
summary: 'Microsoft Azure Add The Specified Predicted Images To The Set Of Training Images'
description: >-
This API creates a batch of images from predicted images specified.
There is a limit of 64 images and 20 tags.<br>If all images are
successful created, 200(OK) status code will be returned.<br>Otherwise,
207 (Multi-Status) status code will be returned and detail status for
each image will be listed in the response payload.
operationId: microsoftAzureCreateimagesfrompredictions
consumes:
- application/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: batch
in: body
description: >-
Image, tag ids, and metadata. Limited to 64 images and 20 tags per
batch.
required: true
schema:
$ref: '#/definitions/ImageIdCreateBatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageCreateSummary'
'207':
description: '207'
schema:
$ref: '#/definitions/ImageCreateSummary'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful CreateImagesFromPredictions request:
$ref: ./examples/CreateImagesFromPredictions.json
/projects/{projectId}/images/regions:
post:
tags:
- ImageApi
summary: 'Microsoft Azure Create A Set Of Image Regions'
description: >-
This API accepts a batch of image regions, and optionally tags, to
update existing images with region information.<br>There is a limit of
64 entries in the batch.<br>If all regions are successful created,
200(OK) status code will be returned.<br>Otherwise, 207 (Multi-Status)
status code will be returned and detail status for each region will be
listed in the response payload.
operationId: microsoftAzureCreateimageregions
consumes:
- application/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: batch
in: body
description: >-
Batch of image regions which include a tag and bounding box. Limited
to 64.
required: true
schema:
$ref: '#/definitions/ImageRegionCreateBatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageRegionCreateSummary'
'207':
description: '207'
schema:
$ref: '#/definitions/ImageRegionCreateSummary'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful CreateImageRegions request:
$ref: ./examples/CreateImageRegions.json
delete:
tags:
- ImageApi
summary: 'Microsoft Azure Delete A Set Of Image Regions'
operationId: microsoftAzureDeleteimageregions
consumes: []
produces: []
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: regionIds
in: query
description: Regions to delete. Limited to 64.
required: true
type: array
items:
type: string
format: uuid
x-nullable: false
collectionFormat: csv
maxItems: 64
minItems: 0
responses:
'204':
description: No Content
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful DeleteImageRegions request:
$ref: ./examples/DeleteImageRegions.json
description: Needs a more full description created.
/projects/{projectId}/images/suggested:
post:
tags:
- ImageApi
summary: >-
Microsoft Azure Get Untagged Images Whose Suggested Tags Match Given Tags Returns Empty Array If No Images Are Found
description: >-
This API will fetch untagged images filtered by suggested tags Ids. It
returns an empty array if no images are found.
operationId: microsoftAzureQuerysuggestedimages
consumes:
- application/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id.
required: true
type: string
format: uuid
x-nullable: false
- name: iterationId
in: query
description: IterationId to use for the suggested tags and regions.
required: true
type: string
format: uuid
x-nullable: false
- name: query
in: body
description: Contains properties we need to query suggested images.
required: true
schema:
$ref: '#/definitions/SuggestedTagAndRegionQueryToken'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SuggestedTagAndRegionQuery'
default:
description: Error response
schema:
$ref: '#/definitions/CustomVisionError'
x-ms-examples:
Successful QuerySuggestedImages request:
$ref: ./examples/QuerySuggestedImages.json
/projects/{projectId}/images/suggested/count:
post:
tags:
- ImageApi
summary: >-
Microsoft Azure Get Count Of Images Whose Suggested Tags Match Given Tags And Their Probabilities Are Greater Than Or Equal To The Given Threshold Returns Count As 0 If None Found
description: >-
This API takes in tagIds to get count of untagged images per suggested
tags for a given threshold.
operationId: microsoftAzureQuerysuggestedimagecount
consumes:
- application/json
- application/xml
- text/xml
-
# --- truncated at 32 KB (128 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/custom-vision-training-client-openapi-original.yml