@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Custom Vision Prediction Client
@base https://southcentralus.api.cognitive.microsoft.com/customvision/v3.0/prediction
@version 3.0
@auth ApiKey Prediction-Key in header
@common_fields {projectId: any # The project id., publishedName: any # Specifies the name of the model to evaluate against., application: any # Optional. Specifies the name of application using the endpoint.}
@endpoints 8
@toc {projectId}(8)

@endpoint POST /{projectId}/classify/iterations/{publishedName}/url
@desc Classify an image url and saves the result.
@required {imageUrl: map # An ImageUrl that contains the url of the image to be evaluated.}
@returns(200) OK

@endpoint POST /{projectId}/classify/iterations/{publishedName}/image
@desc Classify an image and saves the result.
@required {imageData: any # Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.}
@returns(200) OK

@endpoint POST /{projectId}/classify/iterations/{publishedName}/url/nostore
@desc Classify an image url without saving the result.
@required {imageUrl: map # An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.}
@returns(200) OK

@endpoint POST /{projectId}/classify/iterations/{publishedName}/image/nostore
@desc Classify an image without saving the result.
@required {imageData: any # Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 0MB.}
@returns(200) OK

@endpoint POST /{projectId}/detect/iterations/{publishedName}/url
@desc Detect objects in an image url and saves the result.
@required {imageUrl: map # An ImageUrl that contains the url of the image to be evaluated.}
@returns(200) OK

@endpoint POST /{projectId}/detect/iterations/{publishedName}/image
@desc Detect objects in an image and saves the result.
@required {imageData: any # Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.}
@returns(200) OK

@endpoint POST /{projectId}/detect/iterations/{publishedName}/url/nostore
@desc Detect objects in an image url without saving the result.
@required {imageUrl: map # An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.}
@returns(200) OK

@endpoint POST /{projectId}/detect/iterations/{publishedName}/image/nostore
@desc Detect objects in an image without saving the result.
@required {imageData: any # Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 0MB.}
@returns(200) OK

@end