Microsoft Azure Training API is a tool that provides training and education resources for individuals and organizations looking to enhance their skills and knowledge in Microsoft Azure. This API offers a wide range of courses, tutorials, and learning materials that cover various aspects of Azure, such as cloud computing, data management, and artificial intelligence.
swagger: '2.0'
info:
version: '2.1'
title: Microsoft Azure TrainingApi
host: southcentralus.api.cognitive.microsoft.com
basePath: /customvision/v2.1/Training
schemes:
- https
paths:
/domains:
get:
tags:
- DomainsApi
summary: Microsoft Azure Get A List Of The Available Domains
operationId: microsoftAzureGetdomains
consumes: []
produces:
- application/json
- text/json
- application/xml
- text/xml
parameters:
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Domain'
x-nullable: true
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
- text/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
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Domain'
x-ms-examples:
Successful GetDomain request:
$ref: ./examples/GetDomain.json
description: Needs a more full description created.
/projects/{projectId}/images/tagged:
get:
tags:
- ImageApi
summary: Microsoft Azure Get Tagged Images For A Given Project Iteration
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: microsoftAzureGettaggedimages
consumes: []
produces:
- application/json
- text/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
x-nullable: true
- 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
x-nullable: false
collectionFormat: csv
x-nullable: true
- name: orderBy
in: query
description: The ordering. Defaults to newest
required: false
type: string
enum:
- Newest
- Oldest
x-nullable: false
- 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
- 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
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Image'
x-nullable: true
x-ms-examples:
Successful GetTaggedImages request:
$ref: ./examples/GetTaggedImages.json
/projects/{projectId}/images/untagged:
get:
tags:
- ImageApi
summary: Microsoft Azure Get Untagged Images For A Given Project Iteration
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.
operationId: microsoftAzureGetuntaggedimages
consumes: []
produces:
- application/json
- text/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
x-nullable: true
- name: orderBy
in: query
description: The ordering. Defaults to newest
required: false
type: string
enum:
- Newest
- Oldest
x-nullable: false
- 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
- 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
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Image'
x-nullable: true
x-ms-examples:
Successful GetUntaggedImages request:
$ref: ./examples/GetUntaggedImages.json
/projects/{projectId}/images/tagged/count:
get:
tags:
- ImageApi
summary: Microsoft Azure Gets The Number Of Images Tagged With The Provided {tagids}
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: microsoftAzureGettaggedimagecount
consumes: []
produces:
- application/json
- text/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
x-nullable: true
- 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
x-nullable: false
collectionFormat: csv
x-nullable: true
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
format: int32
type: integer
x-nullable: false
x-ms-examples:
Successful GetTaggedImageCount request:
$ref: ./examples/GetTaggedImageCount.json
/projects/{projectId}/images/untagged/count:
get:
tags:
- ImageApi
summary: Microsoft Azure Gets The Number Of Untagged Images
description: >-
This API returns the images which have no tags for a given project and
optionally an iteration. If no iteration is specified the<br>current
workspace is used.
operationId: microsoftAzureGetuntaggedimagecount
consumes: []
produces:
- application/json
- text/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
x-nullable: true
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
format: int32
type: integer
x-nullable: false
x-ms-examples:
Successful GetUntaggedImageCount request:
$ref: ./examples/GetUntaggedImageCount.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
- text/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
x-nullable: false
collectionFormat: csv
x-nullable: true
- name: iterationId
in: query
description: The iteration id. Defaults to workspace
required: false
type: string
format: uuid
x-nullable: true
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Image'
x-nullable: true
x-ms-examples:
Successful GetImagesByIds request:
$ref: ./examples/GetImagesByIds.json
/projects/{projectId}/images:
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
operationId: microsoftAzureCreateimagesfromdata
consumes:
- multipart/form-data
- application/octet-stream
produces:
- application/json
- text/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
x-nullable: false
collectionFormat: csv
x-nullable: true
- name: imageData
in: formData
required: true
type: file
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageCreateSummary'
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: []
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: true
type: array
items:
type: string
x-nullable: false
collectionFormat: csv
x-nullable: true
- $ref: '#/parameters/ApiKey'
responses:
'204':
description: No Content
x-ms-examples:
Successful DeleteImages request:
$ref: ./examples/DeleteImages.json
description: Needs a more full description created.
/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.
operationId: microsoftAzureCreateimagesfromfiles
consumes:
- application/json
- text/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- text/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'
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageCreateSummary'
x-ms-examples:
Successful CreateImagesFromFiles request:
$ref: ./examples/CreateImagesFromFiles.json
/projects/{projectId}/images/urls:
post:
tags:
- ImageApi
summary: Microsoft Azure Add The Provided Images Urls To The Set Of Training Images
description: >-
This API accepts a batch of urls, and optionally tags, to create images.
There is a limit of 64 images and 20 tags.
operationId: microsoftAzureCreateimagesfromurls
consumes:
- application/json
- text/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- text/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 urls and tag ids. Limited to 64 images and 20 tags per batch
required: true
schema:
$ref: '#/definitions/ImageUrlCreateBatch'
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageCreateSummary'
x-ms-examples:
Successful CreateImagesFromUrls request:
$ref: ./examples/CreateImagesFromUrls.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.
operationId: microsoftAzureCreateimagesfrompredictions
consumes:
- application/json
- text/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- text/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 and tag ids. Limited to 64 images and 20 tags per batch
required: true
schema:
$ref: '#/definitions/ImageIdCreateBatch'
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageCreateSummary'
x-ms-examples:
Successful CreateImagesFromPredictions request:
$ref: ./examples/CreateImagesFromPredictions.json
/projects/{projectId}/images/tags:
post:
tags:
- ImageApi
summary: Microsoft Azure Associate A Set Of Images With A Set Of Tags
operationId: microsoftAzureCreateimagetags
consumes:
- application/json
- text/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- text/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 tags. Limited to 128 tags per batch
required: true
schema:
$ref: '#/definitions/ImageTagCreateBatch'
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageTagCreateSummary'
x-ms-examples:
Successful CreateImageTags request:
$ref: ./examples/CreateImageTags.json
description: Needs a more full description created.
delete:
tags:
- ImageApi
summary: Microsoft Azure Remove A Set Of Tags From A Set Of Images
operationId: microsoftAzureDeleteimagetags
consumes: []
produces: []
parameters:
- name: projectId
in: path
description: The project id
required: true
type: string
format: uuid
x-nullable: false
- name: imageIds
in: query
description: Image ids. Limited to 64 images
required: true
type: array
items:
type: string
x-nullable: false
collectionFormat: csv
x-nullable: true
- name: tagIds
in: query
description: Tags to be deleted from the specified images. Limited to 20 tags
required: true
type: array
items:
type: string
x-nullable: false
collectionFormat: csv
x-nullable: true
- $ref: '#/parameters/ApiKey'
responses:
'204':
description: No Content
x-ms-examples:
Successful DeleteImageTags request:
$ref: ./examples/DeleteImageTags.json
description: Needs a more full description created.
/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.
operationId: microsoftAzureCreateimageregions
consumes:
- application/json
- text/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- text/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'
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageRegionCreateSummary'
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
x-nullable: false
collectionFormat: csv
x-nullable: true
- $ref: '#/parameters/ApiKey'
responses:
'204':
description: No Content
x-ms-examples:
Successful DeleteImageRegions request:
$ref: ./examples/DeleteImageRegions.json
description: Needs a more full description created.
/{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
- text/json
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
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImageRegionProposal'
x-ms-examples:
Successful GetImageRegionProposals request:
$ref: ./examples/GetImageRegionProposals.json
/projects/{projectId}/predictions:
delete:
tags:
- PredictionsApi
summary: Microsoft Azure Delete A Set Of Predicted Images And Their Associated Prediction Results
operationId: microsoftAzureDeleteprediction
consumes: []
produces: []
parameters:
- name: projectId
in: path
description: The project id
required: true
type: string
format: uuid
x-nullable: false
- name: ids
in: query
description: The prediction ids. Limited to 64
required: true
type: array
items:
type: string
x-nullable: false
collectionFormat: csv
x-nullable: true
- $ref: '#/parameters/ApiKey'
responses:
'204':
description: No Content
x-ms-examples:
Successful DeletePrediction request:
$ref: ./examples/DeletePrediction.json
description: Needs a more full description created.
/projects/{projectId}/predictions/query:
post:
tags:
- PredictionsApi
summary: Microsoft Azure Get Images That Were Sent To Your Prediction Endpoint
operationId: microsoftAzureQuerypredictions
consumes:
- application/json
- text/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- text/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id
required: true
type: string
format: uuid
x-nullable: false
- name: query
in: body
description: >-
Parameters used to query the predictions. Limited to combining 2
tags
required: true
schema:
$ref: '#/definitions/PredictionQueryToken'
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/PredictionQueryResult'
x-ms-examples:
Successful QueryPredictions request:
$ref: ./examples/QueryPredictions.json
description: Needs a more full description created.
/projects/{projectId}/quicktest/url:
post:
tags:
- PredictionsApi
summary: Microsoft Azure Quick Test An Image Url
operationId: microsoftAzureQuicktestimageurl
consumes:
- application/json
- text/json
- application/xml
- text/xml
- application/x-www-form-urlencoded
produces:
- application/json
- text/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project to evaluate against
required: true
type: string
format: uuid
x-nullable: false
- name: imageUrl
in: body
description: >-
An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image
to be evaluated
required: true
schema:
$ref: '#/definitions/ImageUrl'
- name: iterationId
in: query
description: "Optional. Specifies the id of a particular iteration to evaluate against.\r\n The default iteration for the project will be used when not specified."
required: false
type: string
format: uuid
x-nullable: true
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImagePrediction'
x-ms-examples:
Successful QuickTestImageUrl request:
$ref: ./examples/QuickTestImageUrl.json
description: Needs a more full description created.
/projects/{projectId}/quicktest/image:
post:
tags:
- PredictionsApi
summary: Microsoft Azure Quick Test An Image
operationId: microsoftAzureQuicktestimage
consumes:
- multipart/form-data
- application/octet-stream
produces:
- application/json
- text/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: "Optional. Specifies the id of a particular iteration to evaluate against.\r\n The default iteration for the project will be used when not specified."
required: false
type: string
format: uuid
x-nullable: true
- name: imageData
in: formData
required: true
type: file
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ImagePrediction'
x-ms-examples:
Successful QuickTestImage request:
$ref: ./examples/QuickTestImage.json
description: Needs a more full description created.
/projects/{projectId}/train:
post:
tags:
- ProjectApi
summary: Microsoft Azure Queues Project For Training
operationId: microsoftAzureTrainproject
consumes: []
produces:
- application/json
- text/json
- application/xml
- text/xml
parameters:
- name: projectId
in: path
description: The project id
required: true
type: string
format: uuid
x-nullable: false
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Iteration'
x-ms-examples:
Successful TrainProject request:
$ref: ./examples/TrainProject.json
description: Needs a more full description created.
/projects:
get:
tags:
- ProjectApi
summary: Microsoft Azure Get Your Projects
operationId: microsoftAzureGetprojects
consumes: []
produces:
- application/json
- text/json
- application/xml
- text/xml
parameters:
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Project'
x-nullable: true
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
- text/json
- application/xml
- text/xml
parameters:
- name: name
in: query
description: Name of the project
required: true
type: string
x-nullable: true
- name: description
in: query
description: The description of the project
required: false
type: string
x-nullable: true
- name: domainId
in: query
description: The id of the domain to use for this project. Defaults to General
required: false
type: string
format: uuid
x-nullable: true
- name: classificationType
in: query
description: The type of classifier to create for this project
required: false
type: string
enum:
- Multiclass
- Multilabel
x-nullable: false
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Project'
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
- text/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
- $ref: '#/parameters/ApiKey'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Project'
x-ms-examples:
Successful GetProject request:
$ref: ./examples/GetProject.json
description: Needs a more full description created.
delete:
tags:
- ProjectApi
summary: Microsoft Azure Delete
# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/trainingapi-openapi-original.yml