Tell us about your PDF experience.

Custom Vision REST API reference -

Azure Cognitive Services
Article • 09/13/2022

This article demonstrates how to call a REST API endpoint for Custom Vision service in
Azure Cognitive Services suite.. Custom Vision lets you build, deploy, and improve your
own image classifiers. An image classifier is an AI service that applies labels (which
represent classes) to images, based on their visual characteristics.

Call the Custom Vision endpoint

1. Start by creating an Azure Cognitive Services resource, and within that specifically
a Custom Vision resource. For instructions, see Create a Cognitive Services
resource using the portal.

2. From the Azure Portal, copy the key and endpoint required to make the call. For
instructions, see Get the keys for your resource.

3. From the left navigation on this article, expand the node for the version of the API
you want to work on, and then select the operation that you want to perform (e.g.,
Classify Image). On the right pane, select Try It.

4. In the REST API Try It pane, perform the following steps:

a. In the Endpoint text box, enter the resource endpoint that you copied from the
Azure portal.
b. In the Ocp-Apim-Subscription-Key text box, enter the key that you copied from
the Azure portal. If the call requires any more headers, add those with the
appropriate values as well.
c. Provide other parameters, headers, and message payload (body) as required for
the operation.
d. Select Run.

5. You will see the relevant response with an appropriate response code.

Samples
Visit the Cognitive Services REST API Sample Github repo for various samples on
working with Cognitive Services using REST.
See also
For an overview of the service, see What is Custom Vision?
To create an Azure Cognitive Service resource, see Get started with Azure Cognitive
Service.
To access REST specifications for previous versions of Custom Vision API, see this
Github repo .
Prediction
Article • 10/31/2023

REST Operation Groups

Operation Group

Classify Image

Classify Image Url

Classify Image Url With No Store

Classify Image With No Store

Detect Image

Detect Image Url

Detect Image Url With No Store

Detect Image With No Store

Classify Image
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Operations
ﾉ Expand table

Classify Image Classify an image and saves the result.

Classify Image - Classify Image
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Classify an image and saves the result.

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/classify/iterations/{pub
lishedName}/image

With optional parameters:

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/classify/iterations/{pub
lishedName}/image?application={application}

URI Parameters
ﾉ Expand table

Name In Required Type Description

imageData formData True file Binary image data. Supported formats are
JPEG, GIF, PNG, and BMP. Supports images up
to 4MB.

Endpoint path True string Supported Cognitive Services endpoints.

projectId path True string The project id.

uuid

published path True string Specifies the name of the model to evaluate
Name against.

application query string Optional. Specifies the name of application

using the endpoint.

Request Header
Media Types: "multipart/form-data", "application/octet-stream"

ﾉ Expand table

Name Required Type Description

Prediction-Key True string

Responses
ﾉ Expand table

Name Type Description

200 OK Image OK
Prediction
Media Types: "application/json", "application/xml", "text/xml"

Other Status Custom Error response

Codes VisionError
Media Types: "application/json", "application/xml", "text/xml"

Security

Prediction-Key
Type: apiKey
In: header

Examples

Successful ClassifyImage request

Sample Request

HTTP

HTTP

POST
https://westus.api.cognitive.microsoft.com/customvision/v3.1/prediction/
 64b822c5-8082-4b36-a426-27225f4aa18c/classify/iterations/MyModel1/image

Sample Response
Status code: 200

JSON

{
"id": "951098b2-9b69-427b-bddb-d5cb618874e3",
"project": "64b822c5-8082-4b36-a426-27225f4aa18c",
"iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
"created": "2019-03-06T02:15:00Z",
"predictions": [
{
"tagId": "e31ff107-5505-4753-be42-b369b21b026c",
"tagName": "Hemlock",
"probability": 0.05149666
},
{
"tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
"tagName": "Japanese Cherry",
"probability": 0.000193528482
}
]
}

Definitions
ﾉ Expand table

Name Description

BoundingBox Bounding box that defines a region of an image.

CustomVisionError

CustomVisionErrorCodes The error code.

ImagePrediction Result of an image prediction request.

Prediction Prediction result.

TagType Type of the predicted tag.

BoundingBox
Bounding box that defines a region of an image.

ﾉ Expand table

Name Type Description

height number Height.

left number Coordinate of the left boundary.

top number Coordinate of the top boundary.

width number Width.

CustomVisionError

ﾉ Expand table

Name Type Description

code Custom The error code.

VisionError
Codes

message string A message explaining the error reported by the service.

CustomVisionErrorCodes
The error code.

ﾉ Expand table

Name Type Description

BadRequest string

BadRequestCannotMigrateProjectWithName string

BadRequestClassificationTrainingValidationFailed string

BadRequestCustomerManagedKeyRevoked string

BadRequestDetectionTrainingNotAllowNegativeTag string

BadRequestDetectionTrainingValidationFailed string

BadRequestDomainNotSupportedForAdvancedTraining string
BadRequestExceedIterationPerProjectLimit string

BadRequestExceedProjectLimit string

BadRequestExceedTagPerImageLimit string

BadRequestExceedTagPerProjectLimit string

BadRequestExceededBatchSize string

BadRequestExceededQuota string

BadRequestExportAlreadyInProgress string

BadRequestExportPlatformNotSupportedForAdvancedTraining string

BadRequestExportValidationFailed string

BadRequestExportWhileTraining string

BadRequestImageBatch string

BadRequestImageDimensions string

BadRequestImageExceededCount string

BadRequestImageFormat string

BadRequestImageMetadataKey string

BadRequestImageMetadataValue string

BadRequestImageRegions string

BadRequestImageSizeBytes string

BadRequestImageStream string

BadRequestImageTags string

BadRequestImageUrl string

BadRequestInvalid string

BadRequestInvalidArtifactUri string

BadRequestInvalidEmailAddress string

BadRequestInvalidIds string

BadRequestInvalidImportToken string

BadRequestInvalidPublishName string
BadRequestInvalidPublishTarget string

BadRequestIterationDescription string

BadRequestIterationIsNotTrained string

BadRequestIterationIsPublished string

BadRequestIterationName string

BadRequestIterationNameNotUnique string

BadRequestIterationNotPublished string

BadRequestIterationValidationFailed string

BadRequestMultiClassClassificationTrainingValidationFailed string

BadRequestMultiLabelClassificationTrainingValidationFailed string

BadRequestMultipleGeneralProductTag string

BadRequestMultipleNegativeTag string

BadRequestNegativeAndRegularTagOnSameImage string

BadRequestNotLimitedTrial string

BadRequestNotSupported string

BadRequestOperationNotSupported string

BadRequestPredictionIdsExceededCount string

BadRequestPredictionIdsMissing string

BadRequestPredictionInvalidApplicationName string

BadRequestPredictionInvalidQueryParameters string

BadRequestPredictionResultsExceededCount string

BadRequestPredictionTagsExceededCount string

BadRequestProjectDescription string

BadRequestProjectDuplicated string

BadRequestProjectImagePreprocessingSettings string

BadRequestProjectName string

BadRequestProjectNameNotUnique string
BadRequestProjectUnknownClassification string

BadRequestProjectUnknownDomain string

BadRequestProjectUnsupportedDomainTypeChange string

BadRequestProjectUnsupportedExportPlatform string

BadRequestRequiredParamIsNull string

BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining string

BadRequestSubscriptionApi string

BadRequestTagDescription string

BadRequestTagName string

BadRequestTagNameNotUnique string

BadRequestTagType string

BadRequestTrainingAlreadyInProgress string

BadRequestTrainingNotNeeded string

BadRequestTrainingNotNeededButTrainingPipelineUpdated string

BadRequestTrainingValidationFailed string

BadRequestUnpublishFailed string

BadRequestUnsupportedDomain string

BadRequestWorkspaceCannotBeModified string

BadRequestWorkspaceNotDeletable string

Conflict string

ConflictInvalid string

ErrorExporterInvalidClassifier string

ErrorExporterInvalidFeaturizer string

ErrorExporterInvalidPlatform string

ErrorFeaturizationAugmentationError string

ErrorFeaturizationAugmentationUnavailable string

ErrorFeaturizationInvalidFeaturizer string
ErrorFeaturizationQueueTimeout string

ErrorFeaturizationServiceUnavailable string

ErrorFeaturizationUnrecognizedJob string

ErrorInvalid string

ErrorIterationCopyFailed string

ErrorPrediction string

ErrorPredictionModelNotCached string

ErrorPredictionModelNotFound string

ErrorPredictionServiceUnavailable string

ErrorPredictionStorage string

ErrorPreparePerformanceMigrationFailed string

ErrorProjectExportRequestFailed string

ErrorProjectImportRequestFailed string

ErrorProjectInvalidDomain string

ErrorProjectInvalidPipelineConfiguration string

ErrorProjectInvalidWorkspace string

ErrorProjectTrainingRequestFailed string

ErrorRegionProposal string

ErrorUnknown string

ErrorUnknownBaseModel string

Forbidden string

ForbiddenDRModeEnabled string

ForbiddenInvalid string

ForbiddenUser string

ForbiddenUserDisabled string

ForbiddenUserDoesNotExist string

ForbiddenUserInsufficientCapability string
 ForbiddenUserResource string

ForbiddenUserSignupAllowanceExceeded string

ForbiddenUserSignupDisabled string

NoError string

NotFound string

NotFoundApimSubscription string

NotFoundDomain string

NotFoundImage string

NotFoundInvalid string

NotFoundIteration string

NotFoundIterationPerformance string

NotFoundProject string

NotFoundProjectDefaultIteration string

NotFoundTag string

UnsupportedMediaType string

ImagePrediction
Result of an image prediction request.

ﾉ Expand table

Name Type Description

created string Date this prediction was created.

id string Prediction Id.

iteration string Iteration Id.

predictions Prediction[] List of predictions.

project string Project Id.

Prediction
Prediction result.

ﾉ Expand table

Name Type Description

boundingBox Bounding Bounding box of the prediction.

Box

probability number Probability of the tag.

tagId string Id of the predicted tag.

tagName string Name of the predicted tag.

tagType TagType Type of the predicted tag.

TagType
Type of the predicted tag.

ﾉ Expand table

Name Type Description

GeneralProduct string

Negative string

Regular string
Classify Image Url
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Operations
ﾉ Expand table

Classify Image Url Classify an image url and saves the result.
Classify Image Url - Classify Image Url
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Classify an image url and saves the result.

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/classify/iterations/{pub
lishedName}/url

With optional parameters:

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/classify/iterations/{pub
lishedName}/url?application={application}

URI Parameters
ﾉ Expand table

Name In Required Type Description

Endpoint path True string Supported Cognitive Services endpoints.

projectId path True string The project id.

uuid

published path True string Specifies the name of the model to evaluate
Name against.

application query string Optional. Specifies the name of application using

the endpoint.

Request Header
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-
urlencoded"
 ﾉ Expand table

Name Required Type Description

Prediction-Key True string

Request Body
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-
urlencoded"

ﾉ Expand table

Name Required Type Description

url True string Url of the image.

Responses
ﾉ Expand table

Name Type Description

200 OK Image OK
Prediction
Media Types: "application/json", "application/xml", "text/xml"

Other Status Custom Error response

Codes VisionError
Media Types: "application/json", "application/xml", "text/xml"

Security

Prediction-Key
Type: apiKey
In: header

Examples

Successful ClassifyImageUrl request

Sample Request

HTTP

HTTP

POST
https://westus.api.cognitive.microsoft.com/customvision/v3.1/prediction/
64b822c5-8082-4b36-a426-27225f4aa18c/classify/iterations/MyModel1/url

{
"url": "{Image URL}"
}

Sample Response
Status code: 200

JSON

{
"id": "951098b2-9b69-427b-bddb-d5cb618874e3",
"project": "64b822c5-8082-4b36-a426-27225f4aa18c",
"iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
"created": "2019-03-06T02:15:00Z",
"predictions": [
{
"tagId": "e31ff107-5505-4753-be42-b369b21b026c",
"tagName": "Hemlock",
"probability": 0.05149666
},
{
"tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
"tagName": "Japanese Cherry",
"probability": 0.000193528482
}
]
}

Definitions
ﾉ Expand table

Name Description
 BoundingBox Bounding box that defines a region of an image.

CustomVisionError

CustomVisionErrorCodes The error code.

ImagePrediction Result of an image prediction request.

ImageUrl Image url.

Prediction Prediction result.

TagType Type of the predicted tag.

BoundingBox
Bounding box that defines a region of an image.

ﾉ Expand table

Name Type Description

height number Height.

left number Coordinate of the left boundary.

top number Coordinate of the top boundary.

width number Width.

CustomVisionError

ﾉ Expand table

Name Type Description

code Custom The error code.

VisionError
Codes

message string A message explaining the error reported by the service.

CustomVisionErrorCodes
The error code.
 ﾉ Expand table

Name Type Description

BadRequest string

BadRequestCannotMigrateProjectWithName string

BadRequestClassificationTrainingValidationFailed string

BadRequestCustomerManagedKeyRevoked string

BadRequestDetectionTrainingNotAllowNegativeTag string

BadRequestDetectionTrainingValidationFailed string

BadRequestDomainNotSupportedForAdvancedTraining string

BadRequestExceedIterationPerProjectLimit string

BadRequestExceedProjectLimit string

BadRequestExceedTagPerImageLimit string

BadRequestExceedTagPerProjectLimit string

BadRequestExceededBatchSize string

BadRequestExceededQuota string

BadRequestExportAlreadyInProgress string

BadRequestExportPlatformNotSupportedForAdvancedTraining string

BadRequestExportValidationFailed string

BadRequestExportWhileTraining string

BadRequestImageBatch string

BadRequestImageDimensions string

BadRequestImageExceededCount string

BadRequestImageFormat string

BadRequestImageMetadataKey string

BadRequestImageMetadataValue string

BadRequestImageRegions string

BadRequestImageSizeBytes string
BadRequestImageStream string

BadRequestImageTags string

BadRequestImageUrl string

BadRequestInvalid string

BadRequestInvalidArtifactUri string

BadRequestInvalidEmailAddress string

BadRequestInvalidIds string

BadRequestInvalidImportToken string

BadRequestInvalidPublishName string

BadRequestInvalidPublishTarget string

BadRequestIterationDescription string

BadRequestIterationIsNotTrained string

BadRequestIterationIsPublished string

BadRequestIterationName string

BadRequestIterationNameNotUnique string

BadRequestIterationNotPublished string

BadRequestIterationValidationFailed string

BadRequestMultiClassClassificationTrainingValidationFailed string

BadRequestMultiLabelClassificationTrainingValidationFailed string

BadRequestMultipleGeneralProductTag string

BadRequestMultipleNegativeTag string

BadRequestNegativeAndRegularTagOnSameImage string

BadRequestNotLimitedTrial string

BadRequestNotSupported string

BadRequestOperationNotSupported string

BadRequestPredictionIdsExceededCount string

BadRequestPredictionIdsMissing string
BadRequestPredictionInvalidApplicationName string

BadRequestPredictionInvalidQueryParameters string

BadRequestPredictionResultsExceededCount string

BadRequestPredictionTagsExceededCount string

BadRequestProjectDescription string

BadRequestProjectDuplicated string

BadRequestProjectImagePreprocessingSettings string

BadRequestProjectName string

BadRequestProjectNameNotUnique string

BadRequestProjectUnknownClassification string

BadRequestProjectUnknownDomain string

BadRequestProjectUnsupportedDomainTypeChange string

BadRequestProjectUnsupportedExportPlatform string

BadRequestRequiredParamIsNull string

BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining string

BadRequestSubscriptionApi string

BadRequestTagDescription string

BadRequestTagName string

BadRequestTagNameNotUnique string

BadRequestTagType string

BadRequestTrainingAlreadyInProgress string

BadRequestTrainingNotNeeded string

BadRequestTrainingNotNeededButTrainingPipelineUpdated string

BadRequestTrainingValidationFailed string

BadRequestUnpublishFailed string

BadRequestUnsupportedDomain string

BadRequestWorkspaceCannotBeModified string
BadRequestWorkspaceNotDeletable string

Conflict string

ConflictInvalid string

ErrorExporterInvalidClassifier string

ErrorExporterInvalidFeaturizer string

ErrorExporterInvalidPlatform string

ErrorFeaturizationAugmentationError string

ErrorFeaturizationAugmentationUnavailable string

ErrorFeaturizationInvalidFeaturizer string

ErrorFeaturizationQueueTimeout string

ErrorFeaturizationServiceUnavailable string

ErrorFeaturizationUnrecognizedJob string

ErrorInvalid string

ErrorIterationCopyFailed string

ErrorPrediction string

ErrorPredictionModelNotCached string

ErrorPredictionModelNotFound string

ErrorPredictionServiceUnavailable string

ErrorPredictionStorage string

ErrorPreparePerformanceMigrationFailed string

ErrorProjectExportRequestFailed string

ErrorProjectImportRequestFailed string

ErrorProjectInvalidDomain string

ErrorProjectInvalidPipelineConfiguration string

ErrorProjectInvalidWorkspace string

ErrorProjectTrainingRequestFailed string

ErrorRegionProposal string
 ErrorUnknown string

ErrorUnknownBaseModel string

Forbidden string

ForbiddenDRModeEnabled string

ForbiddenInvalid string

ForbiddenUser string

ForbiddenUserDisabled string

ForbiddenUserDoesNotExist string

ForbiddenUserInsufficientCapability string

ForbiddenUserResource string

ForbiddenUserSignupAllowanceExceeded string

ForbiddenUserSignupDisabled string

NoError string

NotFound string

NotFoundApimSubscription string

NotFoundDomain string

NotFoundImage string

NotFoundInvalid string

NotFoundIteration string

NotFoundIterationPerformance string

NotFoundProject string

NotFoundProjectDefaultIteration string

NotFoundTag string

UnsupportedMediaType string

ImagePrediction
Result of an image prediction request.
 ﾉ Expand table

Name Type Description

created string Date this prediction was created.

id string Prediction Id.

iteration string Iteration Id.

predictions Prediction[] List of predictions.

project string Project Id.

ImageUrl
Image url.

ﾉ Expand table

Name Type Description

url string Url of the image.

Prediction
Prediction result.

ﾉ Expand table

Name Type Description

boundingBox Bounding Bounding box of the prediction.

Box

probability number Probability of the tag.

tagId string Id of the predicted tag.

tagName string Name of the predicted tag.

tagType TagType Type of the predicted tag.

TagType
Type of the predicted tag.
 ﾉ Expand table

Name Type Description

GeneralProduct string

Negative string

Regular string
Classify Image Url With No Store
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Operations
ﾉ Expand table

Classify Image Url With No Store Classify an image url without saving the result.
Classify Image Url With No Store -
Classify Image Url With No Store
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Classify an image url without saving the result.

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/classify/iterations/{pub
lishedName}/url/nostore

With optional parameters:

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/classify/iterations/{pub
lishedName}/url/nostore?application={application}

URI Parameters
ﾉ Expand table

Name In Required Type Description

Endpoint path True string Supported Cognitive Services endpoints.

projectId path True string The project id.

uuid

published path True string Specifies the name of the model to evaluate
Name against.

application query string Optional. Specifies the name of application using

the endpoint.

Request Header
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-
urlencoded"

ﾉ Expand table

Name Required Type Description

Prediction-Key True string

Request Body
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-
urlencoded"

ﾉ Expand table

Name Required Type Description

url True string Url of the image.

Responses
ﾉ Expand table

Name Type Description

200 OK Image OK
Prediction
Media Types: "application/json", "application/xml", "text/xml"

Other Status Custom Error response

Codes VisionError
Media Types: "application/json", "application/xml", "text/xml"

Security

Prediction-Key
Type: apiKey
In: header
Examples

Successful ClassifyImageUrlWithNoStore request

Sample Request

HTTP

HTTP

POST
https://westus.api.cognitive.microsoft.com/customvision/v3.1/prediction/
64b822c5-8082-4b36-a426-
27225f4aa18c/classify/iterations/MyModel1/url/nostore

{
"url": "{Image URL}"
}

Sample Response
Status code: 200

JSON

{
"id": "951098b2-9b69-427b-bddb-d5cb618874e3",
"project": "64b822c5-8082-4b36-a426-27225f4aa18c",
"iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
"created": "2019-03-06T02:15:00Z",
"predictions": [
{
"tagId": "e31ff107-5505-4753-be42-b369b21b026c",
"tagName": "Hemlock",
"probability": 0.05149666
},
{
"tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
"tagName": "Japanese Cherry",
"probability": 0.000193528482
}
]
}
Definitions
ﾉ Expand table

Name Description

BoundingBox Bounding box that defines a region of an image.

CustomVisionError

CustomVisionErrorCodes The error code.

ImagePrediction Result of an image prediction request.

ImageUrl Image url.

Prediction Prediction result.

TagType Type of the predicted tag.

BoundingBox
Bounding box that defines a region of an image.

ﾉ Expand table

Name Type Description

height number Height.

left number Coordinate of the left boundary.

top number Coordinate of the top boundary.

width number Width.

CustomVisionError

ﾉ Expand table

Name Type Description

code Custom The error code.

VisionError
Codes

message string A message explaining the error reported by the service.

CustomVisionErrorCodes
The error code.

ﾉ Expand table

Name Type Description

BadRequest string

BadRequestCannotMigrateProjectWithName string

BadRequestClassificationTrainingValidationFailed string

BadRequestCustomerManagedKeyRevoked string

BadRequestDetectionTrainingNotAllowNegativeTag string

BadRequestDetectionTrainingValidationFailed string

BadRequestDomainNotSupportedForAdvancedTraining string

BadRequestExceedIterationPerProjectLimit string

BadRequestExceedProjectLimit string

BadRequestExceedTagPerImageLimit string

BadRequestExceedTagPerProjectLimit string

BadRequestExceededBatchSize string

BadRequestExceededQuota string

BadRequestExportAlreadyInProgress string

BadRequestExportPlatformNotSupportedForAdvancedTraining string

BadRequestExportValidationFailed string

BadRequestExportWhileTraining string

BadRequestImageBatch string

BadRequestImageDimensions string

BadRequestImageExceededCount string

BadRequestImageFormat string

BadRequestImageMetadataKey string

BadRequestImageMetadataValue string
BadRequestImageRegions string

BadRequestImageSizeBytes string

BadRequestImageStream string

BadRequestImageTags string

BadRequestImageUrl string

BadRequestInvalid string

BadRequestInvalidArtifactUri string

BadRequestInvalidEmailAddress string

BadRequestInvalidIds string

BadRequestInvalidImportToken string

BadRequestInvalidPublishName string

BadRequestInvalidPublishTarget string

BadRequestIterationDescription string

BadRequestIterationIsNotTrained string

BadRequestIterationIsPublished string

BadRequestIterationName string

BadRequestIterationNameNotUnique string

BadRequestIterationNotPublished string

BadRequestIterationValidationFailed string

BadRequestMultiClassClassificationTrainingValidationFailed string

BadRequestMultiLabelClassificationTrainingValidationFailed string

BadRequestMultipleGeneralProductTag string

BadRequestMultipleNegativeTag string

BadRequestNegativeAndRegularTagOnSameImage string

BadRequestNotLimitedTrial string

BadRequestNotSupported string

BadRequestOperationNotSupported string
BadRequestPredictionIdsExceededCount string

BadRequestPredictionIdsMissing string

BadRequestPredictionInvalidApplicationName string

BadRequestPredictionInvalidQueryParameters string

BadRequestPredictionResultsExceededCount string

BadRequestPredictionTagsExceededCount string

BadRequestProjectDescription string

BadRequestProjectDuplicated string

BadRequestProjectImagePreprocessingSettings string

BadRequestProjectName string

BadRequestProjectNameNotUnique string

BadRequestProjectUnknownClassification string

BadRequestProjectUnknownDomain string

BadRequestProjectUnsupportedDomainTypeChange string

BadRequestProjectUnsupportedExportPlatform string

BadRequestRequiredParamIsNull string

BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining string

BadRequestSubscriptionApi string

BadRequestTagDescription string

BadRequestTagName string

BadRequestTagNameNotUnique string

BadRequestTagType string

BadRequestTrainingAlreadyInProgress string

BadRequestTrainingNotNeeded string

BadRequestTrainingNotNeededButTrainingPipelineUpdated string

BadRequestTrainingValidationFailed string

BadRequestUnpublishFailed string
BadRequestUnsupportedDomain string

BadRequestWorkspaceCannotBeModified string

BadRequestWorkspaceNotDeletable string

Conflict string

ConflictInvalid string

ErrorExporterInvalidClassifier string

ErrorExporterInvalidFeaturizer string

ErrorExporterInvalidPlatform string

ErrorFeaturizationAugmentationError string

ErrorFeaturizationAugmentationUnavailable string

ErrorFeaturizationInvalidFeaturizer string

ErrorFeaturizationQueueTimeout string

ErrorFeaturizationServiceUnavailable string

ErrorFeaturizationUnrecognizedJob string

ErrorInvalid string

ErrorIterationCopyFailed string

ErrorPrediction string

ErrorPredictionModelNotCached string

ErrorPredictionModelNotFound string

ErrorPredictionServiceUnavailable string

ErrorPredictionStorage string

ErrorPreparePerformanceMigrationFailed string

ErrorProjectExportRequestFailed string

ErrorProjectImportRequestFailed string

ErrorProjectInvalidDomain string

ErrorProjectInvalidPipelineConfiguration string

ErrorProjectInvalidWorkspace string
ErrorProjectTrainingRequestFailed string

ErrorRegionProposal string

ErrorUnknown string

ErrorUnknownBaseModel string

Forbidden string

ForbiddenDRModeEnabled string

ForbiddenInvalid string

ForbiddenUser string

ForbiddenUserDisabled string

ForbiddenUserDoesNotExist string

ForbiddenUserInsufficientCapability string

ForbiddenUserResource string

ForbiddenUserSignupAllowanceExceeded string

ForbiddenUserSignupDisabled string

NoError string

NotFound string

NotFoundApimSubscription string

NotFoundDomain string

NotFoundImage string

NotFoundInvalid string

NotFoundIteration string

NotFoundIterationPerformance string

NotFoundProject string

NotFoundProjectDefaultIteration string

NotFoundTag string

UnsupportedMediaType string
ImagePrediction
Result of an image prediction request.

ﾉ Expand table

Name Type Description

created string Date this prediction was created.

id string Prediction Id.

iteration string Iteration Id.

predictions Prediction[] List of predictions.

project string Project Id.

ImageUrl
Image url.

ﾉ Expand table

Name Type Description

url string Url of the image.

Prediction
Prediction result.

ﾉ Expand table

Name Type Description

boundingBox Bounding Bounding box of the prediction.

Box

probability number Probability of the tag.

tagId string Id of the predicted tag.

tagName string Name of the predicted tag.

tagType TagType Type of the predicted tag.

TagType
Type of the predicted tag.

ﾉ Expand table

Name Type Description

GeneralProduct string

Negative string

Regular string
Classify Image With No Store
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Operations
ﾉ Expand table

Classify Image With No Store Classify an image without saving the result.
Classify Image With No Store - Classify
Image With No Store
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Classify an image without saving the result.

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/classify/iterations/{pub
lishedName}/image/nostore

With optional parameters:

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/classify/iterations/{pub
lishedName}/image/nostore?application={application}

URI Parameters
ﾉ Expand table

Name In Required Type Description

imageData formData True file Binary image data. Supported formats are
JPEG, GIF, PNG, and BMP. Supports images up
to 4MB.

Endpoint path True string Supported Cognitive Services endpoints.

projectId path True string The project id.

uuid

published path True string Specifies the name of the model to evaluate
Name against.

application query string Optional. Specifies the name of application

using the endpoint.
Request Header
Media Types: "multipart/form-data", "application/octet-stream"

ﾉ Expand table

Name Required Type Description

Prediction-Key True string

Responses
ﾉ Expand table

Name Type Description

200 OK Image OK
Prediction
Media Types: "application/json", "application/xml", "text/xml"

Other Status Custom Error response

Codes VisionError
Media Types: "application/json", "application/xml", "text/xml"

Security

Prediction-Key
Type: apiKey
In: header

Examples

Successful ClassifyImageWithNoStore request

Sample Request

HTTP

HTTP
 POST
https://westus.api.cognitive.microsoft.com/customvision/v3.1/prediction/
64b822c5-8082-4b36-a426-
27225f4aa18c/classify/iterations/MyModel1/image/nostore

Sample Response
Status code: 200

JSON

{
"id": "951098b2-9b69-427b-bddb-d5cb618874e3",
"project": "64b822c5-8082-4b36-a426-27225f4aa18c",
"iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
"created": "2019-03-06T02:15:00Z",
"predictions": [
{
"tagId": "e31ff107-5505-4753-be42-b369b21b026c",
"tagName": "Hemlock",
"probability": 0.05149666
},
{
"tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
"tagName": "Japanese Cherry",
"probability": 0.000193528482
}
]
}

Definitions
ﾉ Expand table

Name Description

BoundingBox Bounding box that defines a region of an image.

CustomVisionError

CustomVisionErrorCodes The error code.

ImagePrediction Result of an image prediction request.

Prediction Prediction result.

TagType Type of the predicted tag.

BoundingBox
Bounding box that defines a region of an image.

ﾉ Expand table

Name Type Description

height number Height.

left number Coordinate of the left boundary.

top number Coordinate of the top boundary.

width number Width.

CustomVisionError

ﾉ Expand table

Name Type Description

code Custom The error code.

VisionError
Codes

message string A message explaining the error reported by the service.

CustomVisionErrorCodes
The error code.

ﾉ Expand table

Name Type Description

BadRequest string

BadRequestCannotMigrateProjectWithName string

BadRequestClassificationTrainingValidationFailed string

BadRequestCustomerManagedKeyRevoked string

BadRequestDetectionTrainingNotAllowNegativeTag string

BadRequestDetectionTrainingValidationFailed string
BadRequestDomainNotSupportedForAdvancedTraining string

BadRequestExceedIterationPerProjectLimit string

BadRequestExceedProjectLimit string

BadRequestExceedTagPerImageLimit string

BadRequestExceedTagPerProjectLimit string

BadRequestExceededBatchSize string

BadRequestExceededQuota string

BadRequestExportAlreadyInProgress string

BadRequestExportPlatformNotSupportedForAdvancedTraining string

BadRequestExportValidationFailed string

BadRequestExportWhileTraining string

BadRequestImageBatch string

BadRequestImageDimensions string

BadRequestImageExceededCount string

BadRequestImageFormat string

BadRequestImageMetadataKey string

BadRequestImageMetadataValue string

BadRequestImageRegions string

BadRequestImageSizeBytes string

BadRequestImageStream string

BadRequestImageTags string

BadRequestImageUrl string

BadRequestInvalid string

BadRequestInvalidArtifactUri string

BadRequestInvalidEmailAddress string

BadRequestInvalidIds string

BadRequestInvalidImportToken string
BadRequestInvalidPublishName string

BadRequestInvalidPublishTarget string

BadRequestIterationDescription string

BadRequestIterationIsNotTrained string

BadRequestIterationIsPublished string

BadRequestIterationName string

BadRequestIterationNameNotUnique string

BadRequestIterationNotPublished string

BadRequestIterationValidationFailed string

BadRequestMultiClassClassificationTrainingValidationFailed string

BadRequestMultiLabelClassificationTrainingValidationFailed string

BadRequestMultipleGeneralProductTag string

BadRequestMultipleNegativeTag string

BadRequestNegativeAndRegularTagOnSameImage string

BadRequestNotLimitedTrial string

BadRequestNotSupported string

BadRequestOperationNotSupported string

BadRequestPredictionIdsExceededCount string

BadRequestPredictionIdsMissing string

BadRequestPredictionInvalidApplicationName string

BadRequestPredictionInvalidQueryParameters string

BadRequestPredictionResultsExceededCount string

BadRequestPredictionTagsExceededCount string

BadRequestProjectDescription string

BadRequestProjectDuplicated string

BadRequestProjectImagePreprocessingSettings string

BadRequestProjectName string
BadRequestProjectNameNotUnique string

BadRequestProjectUnknownClassification string

BadRequestProjectUnknownDomain string

BadRequestProjectUnsupportedDomainTypeChange string

BadRequestProjectUnsupportedExportPlatform string

BadRequestRequiredParamIsNull string

BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining string

BadRequestSubscriptionApi string

BadRequestTagDescription string

BadRequestTagName string

BadRequestTagNameNotUnique string

BadRequestTagType string

BadRequestTrainingAlreadyInProgress string

BadRequestTrainingNotNeeded string

BadRequestTrainingNotNeededButTrainingPipelineUpdated string

BadRequestTrainingValidationFailed string

BadRequestUnpublishFailed string

BadRequestUnsupportedDomain string

BadRequestWorkspaceCannotBeModified string

BadRequestWorkspaceNotDeletable string

Conflict string

ConflictInvalid string

ErrorExporterInvalidClassifier string

ErrorExporterInvalidFeaturizer string

ErrorExporterInvalidPlatform string

ErrorFeaturizationAugmentationError string

ErrorFeaturizationAugmentationUnavailable string
ErrorFeaturizationInvalidFeaturizer string

ErrorFeaturizationQueueTimeout string

ErrorFeaturizationServiceUnavailable string

ErrorFeaturizationUnrecognizedJob string

ErrorInvalid string

ErrorIterationCopyFailed string

ErrorPrediction string

ErrorPredictionModelNotCached string

ErrorPredictionModelNotFound string

ErrorPredictionServiceUnavailable string

ErrorPredictionStorage string

ErrorPreparePerformanceMigrationFailed string

ErrorProjectExportRequestFailed string

ErrorProjectImportRequestFailed string

ErrorProjectInvalidDomain string

ErrorProjectInvalidPipelineConfiguration string

ErrorProjectInvalidWorkspace string

ErrorProjectTrainingRequestFailed string

ErrorRegionProposal string

ErrorUnknown string

ErrorUnknownBaseModel string

Forbidden string

ForbiddenDRModeEnabled string

ForbiddenInvalid string

ForbiddenUser string

ForbiddenUserDisabled string

ForbiddenUserDoesNotExist string
 ForbiddenUserInsufficientCapability string

ForbiddenUserResource string

ForbiddenUserSignupAllowanceExceeded string

ForbiddenUserSignupDisabled string

NoError string

NotFound string

NotFoundApimSubscription string

NotFoundDomain string

NotFoundImage string

NotFoundInvalid string

NotFoundIteration string

NotFoundIterationPerformance string

NotFoundProject string

NotFoundProjectDefaultIteration string

NotFoundTag string

UnsupportedMediaType string

ImagePrediction
Result of an image prediction request.

ﾉ Expand table

Name Type Description

created string Date this prediction was created.

id string Prediction Id.

iteration string Iteration Id.

predictions Prediction[] List of predictions.

project string Project Id.

Prediction
Prediction result.

ﾉ Expand table

Name Type Description

boundingBox Bounding Bounding box of the prediction.

Box

probability number Probability of the tag.

tagId string Id of the predicted tag.

tagName string Name of the predicted tag.

tagType TagType Type of the predicted tag.

TagType
Type of the predicted tag.

ﾉ Expand table

Name Type Description

GeneralProduct string

Negative string

Regular string
Detect Image
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Operations
ﾉ Expand table

Detect Image Detect objects in an image and saves the result.

Detect Image - Detect Image
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Detect objects in an image and saves the result.

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/detect/iterations/{publi
shedName}/image

With optional parameters:

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/detect/iterations/{publi
shedName}/image?application={application}

URI Parameters
ﾉ Expand table

Name In Required Type Description

imageData formData True file Binary image data. Supported formats are
JPEG, GIF, PNG, and BMP. Supports images up
to 4MB.

Endpoint path True string Supported Cognitive Services endpoints.

projectId path True string The project id.

uuid

published path True string Specifies the name of the model to evaluate
Name against.

application query string Optional. Specifies the name of application

using the endpoint.

Request Header
Media Types: "multipart/form-data", "application/octet-stream"

ﾉ Expand table

Name Required Type Description

Prediction-Key True string

Responses
ﾉ Expand table

Name Type Description

200 OK Image OK
Prediction
Media Types: "application/json", "application/xml", "text/xml"

Other Status Custom Error response

Codes VisionError
Media Types: "application/json", "application/xml", "text/xml"

Security

Prediction-Key
Type: apiKey
In: header

Examples

Successful DetectImage request

Sample Request

HTTP

HTTP

POST
https://westus.api.cognitive.microsoft.com/customvision/v3.1/prediction/
 64b822c5-8082-4b36-a426-27225f4aa18c/detect/iterations/MyModel1/image

Sample Response
Status code: 200

JSON

{
"id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
"project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1",
"iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
"created": "2019-03-10T06:10:28Z",
"predictions": [
{
"tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
"tagName": "Tag 1",
"probability": 0.05149666,
"boundingBox": {
"left": 0.955476165,
"top": 0,
"width": 0.0412225723,
"height": 0.156851858
}
},
{
"tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
"tagName": "Tag 2",
"probability": 0.000193528482,
"boundingBox": {
"left": 0.062178582,
"top": 0,
"width": 0.9378114,
"height": 0.6830492
}
}
]
}

Definitions
ﾉ Expand table

Name Description

BoundingBox Bounding box that defines a region of an image.

CustomVisionError
 CustomVisionErrorCodes The error code.

ImagePrediction Result of an image prediction request.

Prediction Prediction result.

TagType Type of the predicted tag.

BoundingBox
Bounding box that defines a region of an image.

ﾉ Expand table

Name Type Description

height number Height.

left number Coordinate of the left boundary.

top number Coordinate of the top boundary.

width number Width.

CustomVisionError

ﾉ Expand table

Name Type Description

code Custom The error code.

VisionError
Codes

message string A message explaining the error reported by the service.

CustomVisionErrorCodes
The error code.

ﾉ Expand table

Name Type Description

BadRequest string
BadRequestCannotMigrateProjectWithName string

BadRequestClassificationTrainingValidationFailed string

BadRequestCustomerManagedKeyRevoked string

BadRequestDetectionTrainingNotAllowNegativeTag string

BadRequestDetectionTrainingValidationFailed string

BadRequestDomainNotSupportedForAdvancedTraining string

BadRequestExceedIterationPerProjectLimit string

BadRequestExceedProjectLimit string

BadRequestExceedTagPerImageLimit string

BadRequestExceedTagPerProjectLimit string

BadRequestExceededBatchSize string

BadRequestExceededQuota string

BadRequestExportAlreadyInProgress string

BadRequestExportPlatformNotSupportedForAdvancedTraining string

BadRequestExportValidationFailed string

BadRequestExportWhileTraining string

BadRequestImageBatch string

BadRequestImageDimensions string

BadRequestImageExceededCount string

BadRequestImageFormat string

BadRequestImageMetadataKey string

BadRequestImageMetadataValue string

BadRequestImageRegions string

BadRequestImageSizeBytes string

BadRequestImageStream string

BadRequestImageTags string

BadRequestImageUrl string
BadRequestInvalid string

BadRequestInvalidArtifactUri string

BadRequestInvalidEmailAddress string

BadRequestInvalidIds string

BadRequestInvalidImportToken string

BadRequestInvalidPublishName string

BadRequestInvalidPublishTarget string

BadRequestIterationDescription string

BadRequestIterationIsNotTrained string

BadRequestIterationIsPublished string

BadRequestIterationName string

BadRequestIterationNameNotUnique string

BadRequestIterationNotPublished string

BadRequestIterationValidationFailed string

BadRequestMultiClassClassificationTrainingValidationFailed string

BadRequestMultiLabelClassificationTrainingValidationFailed string

BadRequestMultipleGeneralProductTag string

BadRequestMultipleNegativeTag string

BadRequestNegativeAndRegularTagOnSameImage string

BadRequestNotLimitedTrial string

BadRequestNotSupported string

BadRequestOperationNotSupported string

BadRequestPredictionIdsExceededCount string

BadRequestPredictionIdsMissing string

BadRequestPredictionInvalidApplicationName string

BadRequestPredictionInvalidQueryParameters string

BadRequestPredictionResultsExceededCount string
BadRequestPredictionTagsExceededCount string

BadRequestProjectDescription string

BadRequestProjectDuplicated string

BadRequestProjectImagePreprocessingSettings string

BadRequestProjectName string

BadRequestProjectNameNotUnique string

BadRequestProjectUnknownClassification string

BadRequestProjectUnknownDomain string

BadRequestProjectUnsupportedDomainTypeChange string

BadRequestProjectUnsupportedExportPlatform string

BadRequestRequiredParamIsNull string

BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining string

BadRequestSubscriptionApi string

BadRequestTagDescription string

BadRequestTagName string

BadRequestTagNameNotUnique string

BadRequestTagType string

BadRequestTrainingAlreadyInProgress string

BadRequestTrainingNotNeeded string

BadRequestTrainingNotNeededButTrainingPipelineUpdated string

BadRequestTrainingValidationFailed string

BadRequestUnpublishFailed string

BadRequestUnsupportedDomain string

BadRequestWorkspaceCannotBeModified string

BadRequestWorkspaceNotDeletable string

Conflict string

ConflictInvalid string
ErrorExporterInvalidClassifier string

ErrorExporterInvalidFeaturizer string

ErrorExporterInvalidPlatform string

ErrorFeaturizationAugmentationError string

ErrorFeaturizationAugmentationUnavailable string

ErrorFeaturizationInvalidFeaturizer string

ErrorFeaturizationQueueTimeout string

ErrorFeaturizationServiceUnavailable string

ErrorFeaturizationUnrecognizedJob string

ErrorInvalid string

ErrorIterationCopyFailed string

ErrorPrediction string

ErrorPredictionModelNotCached string

ErrorPredictionModelNotFound string

ErrorPredictionServiceUnavailable string

ErrorPredictionStorage string

ErrorPreparePerformanceMigrationFailed string

ErrorProjectExportRequestFailed string

ErrorProjectImportRequestFailed string

ErrorProjectInvalidDomain string

ErrorProjectInvalidPipelineConfiguration string

ErrorProjectInvalidWorkspace string

ErrorProjectTrainingRequestFailed string

ErrorRegionProposal string

ErrorUnknown string

ErrorUnknownBaseModel string

Forbidden string
 ForbiddenDRModeEnabled string

ForbiddenInvalid string

ForbiddenUser string

ForbiddenUserDisabled string

ForbiddenUserDoesNotExist string

ForbiddenUserInsufficientCapability string

ForbiddenUserResource string

ForbiddenUserSignupAllowanceExceeded string

ForbiddenUserSignupDisabled string

NoError string

NotFound string

NotFoundApimSubscription string

NotFoundDomain string

NotFoundImage string

NotFoundInvalid string

NotFoundIteration string

NotFoundIterationPerformance string

NotFoundProject string

NotFoundProjectDefaultIteration string

NotFoundTag string

UnsupportedMediaType string

ImagePrediction
Result of an image prediction request.

ﾉ Expand table

Name Type Description

created string Date this prediction was created.

 id string Prediction Id.

iteration string Iteration Id.

predictions Prediction[] List of predictions.

project string Project Id.

Prediction
Prediction result.

ﾉ Expand table

Name Type Description

boundingBox Bounding Bounding box of the prediction.

Box

probability number Probability of the tag.

tagId string Id of the predicted tag.

tagName string Name of the predicted tag.

tagType TagType Type of the predicted tag.

TagType
Type of the predicted tag.

ﾉ Expand table

Name Type Description

GeneralProduct string

Negative string

Regular string
Detect Image Url
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Operations
ﾉ Expand table

Detect Image Url Detect objects in an image url and saves the result.
Detect Image Url - Detect Image Url
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Detect objects in an image url and saves the result.

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/detect/iterations/{publi
shedName}/url

With optional parameters:

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/detect/iterations/{publi
shedName}/url?application={application}

URI Parameters
ﾉ Expand table

Name In Required Type Description

Endpoint path True string Supported Cognitive Services endpoints.

projectId path True string The project id.

uuid

published path True string Specifies the name of the model to evaluate
Name against.

application query string Optional. Specifies the name of application using

the endpoint.

Request Header
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-
urlencoded"
 ﾉ Expand table

Name Required Type Description

Prediction-Key True string

Request Body
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-
urlencoded"

ﾉ Expand table

Name Required Type Description

url True string Url of the image.

Responses
ﾉ Expand table

Name Type Description

200 OK Image OK
Prediction
Media Types: "application/json", "application/xml", "text/xml"

Other Status Custom Error response

Codes VisionError
Media Types: "application/json", "application/xml", "text/xml"

Security

Prediction-Key
Type: apiKey
In: header

Examples

Successful DetectImageUrl request

Sample Request

HTTP

HTTP

POST
https://westus.api.cognitive.microsoft.com/customvision/v3.1/prediction/
64b822c5-8082-4b36-a426-27225f4aa18c/detect/iterations/MyModel1/url

{
"url": "{Image URL}"
}

Sample Response
Status code: 200

JSON

{
"id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
"project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1",
"iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
"created": "2019-03-10T06:10:28Z",
"predictions": [
{
"tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
"tagName": "Tag 1",
"probability": 0.05149666,
"boundingBox": {
"left": 0.955476165,
"top": 0,
"width": 0.0412225723,
"height": 0.156851858
}
},
{
"tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
"tagName": "Tag 2",
"probability": 0.000193528482,
"boundingBox": {
"left": 0.062178582,
"top": 0,
"width": 0.9378114,
"height": 0.6830492
}
}
 ]
}

Definitions
ﾉ Expand table

Name Description

BoundingBox Bounding box that defines a region of an image.

CustomVisionError

CustomVisionErrorCodes The error code.

ImagePrediction Result of an image prediction request.

ImageUrl Image url.

Prediction Prediction result.

TagType Type of the predicted tag.

BoundingBox
Bounding box that defines a region of an image.

ﾉ Expand table

Name Type Description

height number Height.

left number Coordinate of the left boundary.

top number Coordinate of the top boundary.

width number Width.

CustomVisionError

ﾉ Expand table

Name Type Description

 code Custom The error code.
VisionError
Codes

message string A message explaining the error reported by the service.

CustomVisionErrorCodes
The error code.

ﾉ Expand table

Name Type Description

BadRequest string

BadRequestCannotMigrateProjectWithName string

BadRequestClassificationTrainingValidationFailed string

BadRequestCustomerManagedKeyRevoked string

BadRequestDetectionTrainingNotAllowNegativeTag string

BadRequestDetectionTrainingValidationFailed string

BadRequestDomainNotSupportedForAdvancedTraining string

BadRequestExceedIterationPerProjectLimit string

BadRequestExceedProjectLimit string

BadRequestExceedTagPerImageLimit string

BadRequestExceedTagPerProjectLimit string

BadRequestExceededBatchSize string

BadRequestExceededQuota string

BadRequestExportAlreadyInProgress string

BadRequestExportPlatformNotSupportedForAdvancedTraining string

BadRequestExportValidationFailed string

BadRequestExportWhileTraining string

BadRequestImageBatch string

BadRequestImageDimensions string
BadRequestImageExceededCount string

BadRequestImageFormat string

BadRequestImageMetadataKey string

BadRequestImageMetadataValue string

BadRequestImageRegions string

BadRequestImageSizeBytes string

BadRequestImageStream string

BadRequestImageTags string

BadRequestImageUrl string

BadRequestInvalid string

BadRequestInvalidArtifactUri string

BadRequestInvalidEmailAddress string

BadRequestInvalidIds string

BadRequestInvalidImportToken string

BadRequestInvalidPublishName string

BadRequestInvalidPublishTarget string

BadRequestIterationDescription string

BadRequestIterationIsNotTrained string

BadRequestIterationIsPublished string

BadRequestIterationName string

BadRequestIterationNameNotUnique string

BadRequestIterationNotPublished string

BadRequestIterationValidationFailed string

BadRequestMultiClassClassificationTrainingValidationFailed string

BadRequestMultiLabelClassificationTrainingValidationFailed string

BadRequestMultipleGeneralProductTag string

BadRequestMultipleNegativeTag string
BadRequestNegativeAndRegularTagOnSameImage string

BadRequestNotLimitedTrial string

BadRequestNotSupported string

BadRequestOperationNotSupported string

BadRequestPredictionIdsExceededCount string

BadRequestPredictionIdsMissing string

BadRequestPredictionInvalidApplicationName string

BadRequestPredictionInvalidQueryParameters string

BadRequestPredictionResultsExceededCount string

BadRequestPredictionTagsExceededCount string

BadRequestProjectDescription string

BadRequestProjectDuplicated string

BadRequestProjectImagePreprocessingSettings string

BadRequestProjectName string

BadRequestProjectNameNotUnique string

BadRequestProjectUnknownClassification string

BadRequestProjectUnknownDomain string

BadRequestProjectUnsupportedDomainTypeChange string

BadRequestProjectUnsupportedExportPlatform string

BadRequestRequiredParamIsNull string

BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining string

BadRequestSubscriptionApi string

BadRequestTagDescription string

BadRequestTagName string

BadRequestTagNameNotUnique string

BadRequestTagType string

BadRequestTrainingAlreadyInProgress string
BadRequestTrainingNotNeeded string

BadRequestTrainingNotNeededButTrainingPipelineUpdated string

BadRequestTrainingValidationFailed string

BadRequestUnpublishFailed string

BadRequestUnsupportedDomain string

BadRequestWorkspaceCannotBeModified string

BadRequestWorkspaceNotDeletable string

Conflict string

ConflictInvalid string

ErrorExporterInvalidClassifier string

ErrorExporterInvalidFeaturizer string

ErrorExporterInvalidPlatform string

ErrorFeaturizationAugmentationError string

ErrorFeaturizationAugmentationUnavailable string

ErrorFeaturizationInvalidFeaturizer string

ErrorFeaturizationQueueTimeout string

ErrorFeaturizationServiceUnavailable string

ErrorFeaturizationUnrecognizedJob string

ErrorInvalid string

ErrorIterationCopyFailed string

ErrorPrediction string

ErrorPredictionModelNotCached string

ErrorPredictionModelNotFound string

ErrorPredictionServiceUnavailable string

ErrorPredictionStorage string

ErrorPreparePerformanceMigrationFailed string

ErrorProjectExportRequestFailed string
ErrorProjectImportRequestFailed string

ErrorProjectInvalidDomain string

ErrorProjectInvalidPipelineConfiguration string

ErrorProjectInvalidWorkspace string

ErrorProjectTrainingRequestFailed string

ErrorRegionProposal string

ErrorUnknown string

ErrorUnknownBaseModel string

Forbidden string

ForbiddenDRModeEnabled string

ForbiddenInvalid string

ForbiddenUser string

ForbiddenUserDisabled string

ForbiddenUserDoesNotExist string

ForbiddenUserInsufficientCapability string

ForbiddenUserResource string

ForbiddenUserSignupAllowanceExceeded string

ForbiddenUserSignupDisabled string

NoError string

NotFound string

NotFoundApimSubscription string

NotFoundDomain string

NotFoundImage string

NotFoundInvalid string

NotFoundIteration string

NotFoundIterationPerformance string

NotFoundProject string
 NotFoundProjectDefaultIteration string

NotFoundTag string

UnsupportedMediaType string

ImagePrediction
Result of an image prediction request.

ﾉ Expand table

Name Type Description

created string Date this prediction was created.

id string Prediction Id.

iteration string Iteration Id.

predictions Prediction[] List of predictions.

project string Project Id.

ImageUrl
Image url.

ﾉ Expand table

Name Type Description

url string Url of the image.

Prediction
Prediction result.

ﾉ Expand table

Name Type Description

boundingBox Bounding Bounding box of the prediction.

Box
 probability number Probability of the tag.

tagId string Id of the predicted tag.

tagName string Name of the predicted tag.

tagType TagType Type of the predicted tag.

TagType
Type of the predicted tag.

ﾉ Expand table

Name Type Description

GeneralProduct string

Negative string

Regular string
Detect Image Url With No Store
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Operations
ﾉ Expand table

Detect Image Url With No Store Detect objects in an image url without saving the result.
Detect Image Url With No Store - Detect
Image Url With No Store
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Detect objects in an image url without saving the result.

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/detect/iterations/{publi
shedName}/url/nostore

With optional parameters:

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/detect/iterations/{publi
shedName}/url/nostore?application={application}

URI Parameters
ﾉ Expand table

Name In Required Type Description

Endpoint path True string Supported Cognitive Services endpoints.

projectId path True string The project id.

uuid

published path True string Specifies the name of the model to evaluate
Name against.

application query string Optional. Specifies the name of application using

the endpoint.

Request Header
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-
urlencoded"

ﾉ Expand table

Name Required Type Description

Prediction-Key True string

Request Body
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-
urlencoded"

ﾉ Expand table

Name Required Type Description

url True string Url of the image.

Responses
ﾉ Expand table

Name Type Description

200 OK Image OK
Prediction
Media Types: "application/json", "application/xml", "text/xml"

Other Status Custom Error response

Codes VisionError
Media Types: "application/json", "application/xml", "text/xml"

Security

Prediction-Key
Type: apiKey
In: header
Examples

Successful DetectImageUrlWithNoStore request

Sample Request

HTTP

HTTP

POST
https://westus.api.cognitive.microsoft.com/customvision/v3.1/prediction/
64b822c5-8082-4b36-a426-
27225f4aa18c/detect/iterations/MyModel1/url/nostore

{
"url": "{Image URL}"
}

Sample Response
Status code: 200

JSON

{
"id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
"project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1",
"iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
"created": "2019-03-10T06:10:28Z",
"predictions": [
{
"tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
"tagName": "Tag 1",
"probability": 0.05149666,
"boundingBox": {
"left": 0.955476165,
"top": 0,
"width": 0.0412225723,
"height": 0.156851858
}
},
{
"tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
"tagName": "Tag 2",
"probability": 0.000193528482,
 "boundingBox": {
"left": 0.062178582,
"top": 0,
"width": 0.9378114,
"height": 0.6830492
}
}
]
}

Definitions
ﾉ Expand table

Name Description

BoundingBox Bounding box that defines a region of an image.

CustomVisionError

CustomVisionErrorCodes The error code.

ImagePrediction Result of an image prediction request.

ImageUrl Image url.

Prediction Prediction result.

TagType Type of the predicted tag.

BoundingBox
Bounding box that defines a region of an image.

ﾉ Expand table

Name Type Description

height number Height.

left number Coordinate of the left boundary.

top number Coordinate of the top boundary.

width number Width.

CustomVisionError
 ﾉ Expand table

Name Type Description

code Custom The error code.

VisionError
Codes

message string A message explaining the error reported by the service.

CustomVisionErrorCodes
The error code.

ﾉ Expand table

Name Type Description

BadRequest string

BadRequestCannotMigrateProjectWithName string

BadRequestClassificationTrainingValidationFailed string

BadRequestCustomerManagedKeyRevoked string

BadRequestDetectionTrainingNotAllowNegativeTag string

BadRequestDetectionTrainingValidationFailed string

BadRequestDomainNotSupportedForAdvancedTraining string

BadRequestExceedIterationPerProjectLimit string

BadRequestExceedProjectLimit string

BadRequestExceedTagPerImageLimit string

BadRequestExceedTagPerProjectLimit string

BadRequestExceededBatchSize string

BadRequestExceededQuota string

BadRequestExportAlreadyInProgress string

BadRequestExportPlatformNotSupportedForAdvancedTraining string

BadRequestExportValidationFailed string

BadRequestExportWhileTraining string
BadRequestImageBatch string

BadRequestImageDimensions string

BadRequestImageExceededCount string

BadRequestImageFormat string

BadRequestImageMetadataKey string

BadRequestImageMetadataValue string

BadRequestImageRegions string

BadRequestImageSizeBytes string

BadRequestImageStream string

BadRequestImageTags string

BadRequestImageUrl string

BadRequestInvalid string

BadRequestInvalidArtifactUri string

BadRequestInvalidEmailAddress string

BadRequestInvalidIds string

BadRequestInvalidImportToken string

BadRequestInvalidPublishName string

BadRequestInvalidPublishTarget string

BadRequestIterationDescription string

BadRequestIterationIsNotTrained string

BadRequestIterationIsPublished string

BadRequestIterationName string

BadRequestIterationNameNotUnique string

BadRequestIterationNotPublished string

BadRequestIterationValidationFailed string

BadRequestMultiClassClassificationTrainingValidationFailed string

BadRequestMultiLabelClassificationTrainingValidationFailed string
BadRequestMultipleGeneralProductTag string

BadRequestMultipleNegativeTag string

BadRequestNegativeAndRegularTagOnSameImage string

BadRequestNotLimitedTrial string

BadRequestNotSupported string

BadRequestOperationNotSupported string

BadRequestPredictionIdsExceededCount string

BadRequestPredictionIdsMissing string

BadRequestPredictionInvalidApplicationName string

BadRequestPredictionInvalidQueryParameters string

BadRequestPredictionResultsExceededCount string

BadRequestPredictionTagsExceededCount string

BadRequestProjectDescription string

BadRequestProjectDuplicated string

BadRequestProjectImagePreprocessingSettings string

BadRequestProjectName string

BadRequestProjectNameNotUnique string

BadRequestProjectUnknownClassification string

BadRequestProjectUnknownDomain string

BadRequestProjectUnsupportedDomainTypeChange string

BadRequestProjectUnsupportedExportPlatform string

BadRequestRequiredParamIsNull string

BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining string

BadRequestSubscriptionApi string

BadRequestTagDescription string

BadRequestTagName string

BadRequestTagNameNotUnique string
BadRequestTagType string

BadRequestTrainingAlreadyInProgress string

BadRequestTrainingNotNeeded string

BadRequestTrainingNotNeededButTrainingPipelineUpdated string

BadRequestTrainingValidationFailed string

BadRequestUnpublishFailed string

BadRequestUnsupportedDomain string

BadRequestWorkspaceCannotBeModified string

BadRequestWorkspaceNotDeletable string

Conflict string

ConflictInvalid string

ErrorExporterInvalidClassifier string

ErrorExporterInvalidFeaturizer string

ErrorExporterInvalidPlatform string

ErrorFeaturizationAugmentationError string

ErrorFeaturizationAugmentationUnavailable string

ErrorFeaturizationInvalidFeaturizer string

ErrorFeaturizationQueueTimeout string

ErrorFeaturizationServiceUnavailable string

ErrorFeaturizationUnrecognizedJob string

ErrorInvalid string

ErrorIterationCopyFailed string

ErrorPrediction string

ErrorPredictionModelNotCached string

ErrorPredictionModelNotFound string

ErrorPredictionServiceUnavailable string

ErrorPredictionStorage string
ErrorPreparePerformanceMigrationFailed string

ErrorProjectExportRequestFailed string

ErrorProjectImportRequestFailed string

ErrorProjectInvalidDomain string

ErrorProjectInvalidPipelineConfiguration string

ErrorProjectInvalidWorkspace string

ErrorProjectTrainingRequestFailed string

ErrorRegionProposal string

ErrorUnknown string

ErrorUnknownBaseModel string

Forbidden string

ForbiddenDRModeEnabled string

ForbiddenInvalid string

ForbiddenUser string

ForbiddenUserDisabled string

ForbiddenUserDoesNotExist string

ForbiddenUserInsufficientCapability string

ForbiddenUserResource string

ForbiddenUserSignupAllowanceExceeded string

ForbiddenUserSignupDisabled string

NoError string

NotFound string

NotFoundApimSubscription string

NotFoundDomain string

NotFoundImage string

NotFoundInvalid string

NotFoundIteration string
 NotFoundIterationPerformance string

NotFoundProject string

NotFoundProjectDefaultIteration string

NotFoundTag string

UnsupportedMediaType string

ImagePrediction
Result of an image prediction request.

ﾉ Expand table

Name Type Description

created string Date this prediction was created.

id string Prediction Id.

iteration string Iteration Id.

predictions Prediction[] List of predictions.

project string Project Id.

ImageUrl
Image url.

ﾉ Expand table

Name Type Description

url string Url of the image.

Prediction
Prediction result.

ﾉ Expand table

Name Type Description

 boundingBox Bounding Bounding box of the prediction.
Box

probability number Probability of the tag.

tagId string Id of the predicted tag.

tagName string Name of the predicted tag.

tagType TagType Type of the predicted tag.

TagType
Type of the predicted tag.

ﾉ Expand table

Name Type Description

GeneralProduct string

Negative string

Regular string
Detect Image With No Store
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Operations
ﾉ Expand table

Detect Image With No Store Detect objects in an image without saving the result.
Detect Image With No Store - Detect
Image With No Store
Reference
Service: Cognitive Services - Custom Vision
API Version: 3.1

Detect objects in an image without saving the result.

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/detect/iterations/{publi
shedName}/image/nostore

With optional parameters:

HTTP

POST
{Endpoint}/customvision/v3.1/prediction/{projectId}/detect/iterations/{publi
shedName}/image/nostore?application={application}

URI Parameters
ﾉ Expand table

Name In Required Type Description

imageData formData True file Binary image data. Supported formats are
JPEG, GIF, PNG, and BMP. Supports images up
to 4MB.

Endpoint path True string Supported Cognitive Services endpoints.

projectId path True string The project id.

uuid

published path True string Specifies the name of the model to evaluate
Name against.

application query string Optional. Specifies the name of application

using the endpoint.
Request Header
Media Types: "multipart/form-data", "application/octet-stream"

ﾉ Expand table

Name Required Type Description

Prediction-Key True string

Responses
ﾉ Expand table

Name Type Description

200 OK Image OK
Prediction
Media Types: "application/json", "application/xml", "text/xml"

Other Status Custom Error response

Codes VisionError
Media Types: "application/json", "application/xml", "text/xml"

Security

Prediction-Key
Type: apiKey
In: header

Examples

Successful DetectImageWithNoStore request

Sample Request

HTTP

HTTP
 POST
https://westus.api.cognitive.microsoft.com/customvision/v3.1/prediction/
64b822c5-8082-4b36-a426-
27225f4aa18c/detect/iterations/MyModel1/image/nostore

Sample Response
Status code: 200

JSON

{
"id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
"project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1",
"iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
"created": "2019-03-10T06:10:28Z",
"predictions": [
{
"tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
"tagName": "Tag 1",
"probability": 0.05149666,
"boundingBox": {
"left": 0.955476165,
"top": 0,
"width": 0.0412225723,
"height": 0.156851858
}
},
{
"tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
"tagName": "Tag 2",
"probability": 0.000193528482,
"boundingBox": {
"left": 0.062178582,
"top": 0,
"width": 0.9378114,
"height": 0.6830492
}
}
]
}

Definitions
ﾉ Expand table

Name Description
 BoundingBox Bounding box that defines a region of an image.

CustomVisionError

CustomVisionErrorCodes The error code.

ImagePrediction Result of an image prediction request.

Prediction Prediction result.

TagType Type of the predicted tag.

BoundingBox
Bounding box that defines a region of an image.

ﾉ Expand table

Name Type Description

height number Height.

left number Coordinate of the left boundary.

top number Coordinate of the top boundary.

width number Width.

CustomVisionError

ﾉ Expand table

Name Type Description

code Custom The error code.

VisionError
Codes

message string A message explaining the error reported by the service.

CustomVisionErrorCodes
The error code.

ﾉ Expand table
Name Type Description

BadRequest string

BadRequestCannotMigrateProjectWithName string

BadRequestClassificationTrainingValidationFailed string

BadRequestCustomerManagedKeyRevoked string

BadRequestDetectionTrainingNotAllowNegativeTag string

BadRequestDetectionTrainingValidationFailed string

BadRequestDomainNotSupportedForAdvancedTraining string

BadRequestExceedIterationPerProjectLimit string

BadRequestExceedProjectLimit string

BadRequestExceedTagPerImageLimit string

BadRequestExceedTagPerProjectLimit string

BadRequestExceededBatchSize string

BadRequestExceededQuota string

BadRequestExportAlreadyInProgress string

BadRequestExportPlatformNotSupportedForAdvancedTraining string

BadRequestExportValidationFailed string

BadRequestExportWhileTraining string

BadRequestImageBatch string

BadRequestImageDimensions string

BadRequestImageExceededCount string

BadRequestImageFormat string

BadRequestImageMetadataKey string

BadRequestImageMetadataValue string

BadRequestImageRegions string

BadRequestImageSizeBytes string

BadRequestImageStream string
BadRequestImageTags string

BadRequestImageUrl string

BadRequestInvalid string

BadRequestInvalidArtifactUri string

BadRequestInvalidEmailAddress string

BadRequestInvalidIds string

BadRequestInvalidImportToken string

BadRequestInvalidPublishName string

BadRequestInvalidPublishTarget string

BadRequestIterationDescription string

BadRequestIterationIsNotTrained string

BadRequestIterationIsPublished string

BadRequestIterationName string

BadRequestIterationNameNotUnique string

BadRequestIterationNotPublished string

BadRequestIterationValidationFailed string

BadRequestMultiClassClassificationTrainingValidationFailed string

BadRequestMultiLabelClassificationTrainingValidationFailed string

BadRequestMultipleGeneralProductTag string

BadRequestMultipleNegativeTag string

BadRequestNegativeAndRegularTagOnSameImage string

BadRequestNotLimitedTrial string

BadRequestNotSupported string

BadRequestOperationNotSupported string

BadRequestPredictionIdsExceededCount string

BadRequestPredictionIdsMissing string

BadRequestPredictionInvalidApplicationName string
BadRequestPredictionInvalidQueryParameters string

BadRequestPredictionResultsExceededCount string

BadRequestPredictionTagsExceededCount string

BadRequestProjectDescription string

BadRequestProjectDuplicated string

BadRequestProjectImagePreprocessingSettings string

BadRequestProjectName string

BadRequestProjectNameNotUnique string

BadRequestProjectUnknownClassification string

BadRequestProjectUnknownDomain string

BadRequestProjectUnsupportedDomainTypeChange string

BadRequestProjectUnsupportedExportPlatform string

BadRequestRequiredParamIsNull string

BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining string

BadRequestSubscriptionApi string

BadRequestTagDescription string

BadRequestTagName string

BadRequestTagNameNotUnique string

BadRequestTagType string

BadRequestTrainingAlreadyInProgress string

BadRequestTrainingNotNeeded string

BadRequestTrainingNotNeededButTrainingPipelineUpdated string

BadRequestTrainingValidationFailed string

BadRequestUnpublishFailed string

BadRequestUnsupportedDomain string

BadRequestWorkspaceCannotBeModified string

BadRequestWorkspaceNotDeletable string
Conflict string

ConflictInvalid string

ErrorExporterInvalidClassifier string

ErrorExporterInvalidFeaturizer string

ErrorExporterInvalidPlatform string

ErrorFeaturizationAugmentationError string

ErrorFeaturizationAugmentationUnavailable string

ErrorFeaturizationInvalidFeaturizer string

ErrorFeaturizationQueueTimeout string

ErrorFeaturizationServiceUnavailable string

ErrorFeaturizationUnrecognizedJob string

ErrorInvalid string

ErrorIterationCopyFailed string

ErrorPrediction string

ErrorPredictionModelNotCached string

ErrorPredictionModelNotFound string

ErrorPredictionServiceUnavailable string

ErrorPredictionStorage string

ErrorPreparePerformanceMigrationFailed string

ErrorProjectExportRequestFailed string

ErrorProjectImportRequestFailed string

ErrorProjectInvalidDomain string

ErrorProjectInvalidPipelineConfiguration string

ErrorProjectInvalidWorkspace string

ErrorProjectTrainingRequestFailed string

ErrorRegionProposal string

ErrorUnknown string
 ErrorUnknownBaseModel string

Forbidden string

ForbiddenDRModeEnabled string

ForbiddenInvalid string

ForbiddenUser string

ForbiddenUserDisabled string

ForbiddenUserDoesNotExist string

ForbiddenUserInsufficientCapability string

ForbiddenUserResource string

ForbiddenUserSignupAllowanceExceeded string

ForbiddenUserSignupDisabled string

NoError string

NotFound string

NotFoundApimSubscription string

NotFoundDomain string

NotFoundImage string

NotFoundInvalid string

NotFoundIteration string

NotFoundIterationPerformance string

NotFoundProject string

NotFoundProjectDefaultIteration string

NotFoundTag string

UnsupportedMediaType string

ImagePrediction
Result of an image prediction request.

ﾉ Expand table
 Name Type Description

created string Date this prediction was created.

id string Prediction Id.

iteration string Iteration Id.

predictions Prediction[] List of predictions.

project string Project Id.

Prediction
Prediction result.

ﾉ Expand table

Name Type Description

boundingBox Bounding Bounding box of the prediction.

Box

probability number Probability of the tag.

tagId string Id of the predicted tag.

tagName string Name of the predicted tag.

tagType TagType Type of the predicted tag.

TagType
Type of the predicted tag.

ﾉ Expand table

Name Type Description

GeneralProduct string

Negative string

Regular string