{
"swagger": "2.0",
"info": {
"title": "Custom_Vision_Training_1.0",
"version": "1.0"
},
"host": "cognitivewcusprod.cognitiveservices.azure.com",
"basePath": "/customvision/v1.0/Training",
"schemes": [
"https"
],
"securityDefinitions": {
"apiKeyHeader": {
"type": "apiKey",
"name": "Training-key",
"in": "header"
},
"apiKeyQuery": {
"type": "apiKey",
"name": "Training-key",
"in": "query"
}
},
"security": [
{
"apiKeyHeader": []
},
{
"apiKeyQuery": []
}
],
"x-servers": [
{
"url": "https://cognitivewcusprod.cognitiveservices.azure.com"
},
{
"url": "https://cognitivewcusprod.openai.azure.com"
},
{
"url": "https://westcentralus.api.cognitive.microsoft.com"
}
],
"paths": {
"/projects/{projectId}/images/image": {
"post": {
"description": "Adds the provided images to the current project iteration",
"operationId": "58d5835bc8cb231380095be3",
"summary": "CreateImagesFromData",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
},
{
"name": "tagIds",
"in": "query",
"description": "The tags ids to associate with the image batch.",
"type": "array"
},
{
"name": "imageData",
"in": "formData",
"required": true,
"type": "file"
}
],
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CreateImageSummaryModel"
},
"examples": {
"application/json": {
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
},
"Status": "OK"
}
]
},
"text/json": {
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
},
"Status": "OK"
}
]
},
"application/xml": "\r\n true\r\n \r\n string\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n \r\n OK\r\n \r\n",
"text/xml": "\r\n true\r\n \r\n string\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n \r\n OK\r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/images/predictions": {
"post": {
"description": "Adds the specified predicted images to the current project iteration",
"operationId": "58f6904dc8cb230790062e1a",
"summary": "CreateImagesFromPredictions",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
},
{
"name": "imageIdCreateBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/ImageIdCreateBatch"
},
"description": "Image and tag ids"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CreateImageSummaryModel"
},
"examples": {
"application/json": {
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
},
"Status": "OK"
}
]
},
"text/json": {
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
},
"Status": "OK"
}
]
},
"application/xml": "\r\n true\r\n \r\n string\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n \r\n OK\r\n \r\n",
"text/xml": "\r\n true\r\n \r\n string\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n \r\n OK\r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/images/url": {
"post": {
"description": "Adds the provided images to the current project iteration",
"operationId": "58d5835bc8cb231380095be2",
"summary": "CreateImagesFromUrls",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
},
{
"name": "imageUrlCreateBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/ImageUrlCreateBatch"
},
"description": "Image urls and tag ids"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/CreateImageSummaryModel"
},
"examples": {
"application/json": {
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
},
"Status": "OK"
}
]
},
"text/json": {
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
},
"Status": "OK"
}
]
},
"application/xml": "\r\n true\r\n \r\n string\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n \r\n OK\r\n \r\n",
"text/xml": "\r\n true\r\n \r\n string\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n \r\n OK\r\n \r\n"
}
}
}
}
},
"/projects": {
"post": {
"description": "Create a project",
"operationId": "58e855a0c8cb230790062bc3",
"summary": "CreateProject",
"parameters": [
{
"name": "name",
"in": "query",
"description": "Name of the project to create",
"required": true,
"type": "string"
},
{
"name": "description",
"in": "query",
"description": "The description of the of the project",
"type": "string"
},
{
"name": "domainId",
"in": "query",
"description": "Format - uuid. The id of the domain to enable for this project",
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProjectModel"
},
"examples": {
"application/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"Settings": {
"DomainId": "string"
},
"ThumbnailUri": "string"
},
"text/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"Settings": {
"DomainId": "string"
},
"ThumbnailUri": "string"
},
"application/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n \r\n string\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n \r\n string\r\n"
}
}
}
},
"get": {
"description": "Gets the user's projects",
"operationId": "58d5835bc8cb231380095be9",
"summary": "GetProjects",
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProjectModelArray"
},
"examples": {
"application/json": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"Settings": {
"DomainId": "string"
},
"ThumbnailUri": "string"
}
],
"text/json": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"Settings": {
"DomainId": "string"
},
"ThumbnailUri": "string"
}
],
"application/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n \r\n string\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n \r\n string\r\n"
}
}
}
}
},
"/projects/{projectId}/tags": {
"post": {
"description": "Creates a tag for the project",
"operationId": "58d5835bc8cb231380095bf6",
"summary": "CreateTag",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid.",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "query",
"description": "",
"required": true,
"type": "string"
},
{
"name": "description",
"in": "query",
"description": "",
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageTagModel"
},
"examples": {
"application/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
},
"text/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
},
"application/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n"
}
}
}
},
"get": {
"description": "Get's the project tags for a given project and iteration",
"operationId": "58d5835bc8cb231380095bf5",
"summary": "GetTags",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration id. This will default to the current iteration",
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageTagListModel"
},
"examples": {
"application/json": {
"Tags": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
],
"TotalTaggedImages": 0,
"TotalUntaggedImages": 0
},
"text/json": {
"Tags": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
],
"TotalTaggedImages": 0,
"TotalUntaggedImages": 0
},
"application/xml": "\r\n \r\n string\r\n string\r\n string\r\n 0\r\n \r\n 0\r\n 0\r\n",
"text/xml": "\r\n \r\n string\r\n string\r\n string\r\n 0\r\n \r\n 0\r\n 0\r\n"
}
}
}
}
},
"/projects/{projectId}/images/{imageId}/label/{labelId}": {
"delete": {
"description": "Delete a image label",
"operationId": "58d5835bc8cb231380095be6",
"summary": "DeleteImageLabel",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. Guid of projectId",
"required": true,
"type": "string"
},
{
"name": "imageId",
"in": "path",
"description": "Format - uuid. Guid of imageId",
"required": true,
"type": "string"
},
{
"name": "labelId",
"in": "path",
"description": "Format - uuid. Guid of labelId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageModel"
},
"examples": {
"application/json": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
},
"text/json": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
},
"application/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n",
"text/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/images": {
"delete": {
"description": "Delete images from the current project iteration",
"operationId": "58d5835bc8cb231380095be4",
"summary": "DeleteImages",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. Guid of projectId",
"required": true,
"type": "string"
},
{
"name": "imageIds",
"in": "query",
"description": "Ids of the images to be deleted",
"required": true,
"type": "array"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/projects/{projectId}/iterations/{iterationId}": {
"delete": {
"description": "Delete a specific iteration of a project",
"operationId": "58d5835bc8cb231380095bf0",
"summary": "DeleteIteration",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. Guid of the projectId",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. Guid of the iterationId",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"description": "Get a specific iteration",
"operationId": "58d5835bc8cb231380095bef",
"summary": "GetIteration",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The id of the project the iteration belongs to",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. The id of the iteration to get",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IterationModel"
},
"examples": {
"application/json": {
"Id": "string",
"Name": "string",
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"IsDefault": true
},
"text/json": {
"Id": "string",
"Name": "string",
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"IsDefault": true
},
"application/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n"
}
}
}
},
"patch": {
"description": "Update a specific iteration",
"operationId": "58e855a0c8cb230790062bc5",
"summary": "UpdateIteration",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. Guid of the projectId",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. Guid of the iteration",
"required": true,
"type": "string"
},
{
"name": "iterationModel",
"in": "body",
"schema": {
"$ref": "#/definitions/IterationModel"
},
"description": "The updated iteration model"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IterationModel"
},
"examples": {
"application/json": {
"Id": "string",
"Name": "string",
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"IsDefault": true
},
"text/json": {
"Id": "string",
"Name": "string",
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"IsDefault": true
},
"application/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n"
}
}
}
}
},
"/projects/{projectId}/predictions": {
"delete": {
"operationId": "58f4fa2ec8cb230790062d37",
"summary": "DeletePrediction",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid.",
"required": true,
"type": "string"
},
{
"name": "ids",
"in": "query",
"required": true,
"type": "array"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"operationId": "58f4fa2ec8cb230790062d36",
"summary": "GetPredictionResults",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid.",
"required": true,
"type": "string"
},
{
"name": "maxCount",
"in": "query",
"description": "Format - int32.",
"required": true,
"type": "integer"
},
{
"name": "orderBy",
"in": "query",
"required": true,
"type": "string",
"enum": [
"Newest",
"Oldest",
"Suggested"
]
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid.",
"type": "string"
},
{
"name": "tagIds",
"in": "query",
"type": "array"
},
{
"name": "threshold",
"in": "query",
"description": "Format - float.",
"type": "number"
},
{
"name": "startTime",
"in": "query",
"description": "Format - date-time (as date-time in RFC3339).",
"type": "string"
},
{
"name": "endTime",
"in": "query",
"description": "Format - date-time (as date-time in RFC3339).",
"type": "string"
},
{
"name": "source",
"in": "query",
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PredictionQueryModel"
},
"examples": {
"application/json": {
"Results": [
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
],
"ImageUri": "string",
"ThumbnailUri": "string"
}
],
"Token": {
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"IterationId": "string",
"TagIds": [
"string"
],
"Threshold": 0.0,
"StartTime": "string",
"EndTime": "string",
"Source": "string"
}
},
"text/json": {
"Results": [
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
],
"ImageUri": "string",
"ThumbnailUri": "string"
}
],
"Token": {
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"IterationId": "string",
"TagIds": [
"string"
],
"Threshold": 0.0,
"StartTime": "string",
"EndTime": "string",
"Source": "string"
}
},
"application/xml": "\r\n \r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n string\r\n 0\r\n \r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n Newest\r\n string\r\n string\r\n 0\r\n string\r\n string\r\n \r\n \r\n",
"text/xml": "\r\n \r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n string\r\n 0\r\n \r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n Newest\r\n string\r\n string\r\n 0\r\n string\r\n string\r\n \r\n \r\n"
}
}
}
}
},
"/projects/{projectId}": {
"delete": {
"description": "Delete a specific project",
"operationId": "58d5835bc8cb231380095beb",
"summary": "DeleteProject",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. Guid of the projectId",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"description": "Get a specific project",
"operationId": "58e855a0c8cb230790062bc4",
"summary": "GetProject",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The id of the project to get",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProjectModel"
},
"examples": {
"application/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"Settings": {
"DomainId": "string"
},
"ThumbnailUri": "string"
},
"text/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"Settings": {
"DomainId": "string"
},
"ThumbnailUri": "string"
},
"application/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n \r\n string\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n \r\n string\r\n"
}
}
}
},
"patch": {
"description": "Update a specific project",
"operationId": "58d5835bc8cb231380095bec",
"summary": "UpdateProject",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The id of the project to update",
"required": true,
"type": "string"
},
{
"name": "projectModel",
"in": "body",
"schema": {
"$ref": "#/definitions/ProjectModel"
},
"description": "The updated project model"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProjectModel"
},
"examples": {
"application/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"Settings": {
"DomainId": "string"
},
"ThumbnailUri": "string"
},
"text/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"Settings": {
"DomainId": "string"
},
"ThumbnailUri": "string"
},
"application/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n \r\n string\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n \r\n string\r\n"
}
}
}
}
},
"/projects/{projectId}/tags/{tagId}": {
"delete": {
"description": "Delete a tag for the project",
"operationId": "58d5835bc8cb231380095bf7",
"summary": "DeleteTag",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid.",
"required": true,
"type": "string"
},
{
"name": "tagId",
"in": "path",
"description": "Format - uuid.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"description": "Gets information about a specific tag",
"operationId": "58e855a0c8cb230790062bc7",
"summary": "GetTag",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project this tag belongs to",
"required": true,
"type": "string"
},
{
"name": "tagId",
"in": "path",
"description": "Format - uuid. The id of the tag",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration to retrieve this tag from. Optional, defaults to the current iteration",
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageTagModel"
},
"examples": {
"application/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
},
"text/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
},
"application/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n"
}
}
}
},
"patch": {
"description": "Updates a tag for the project",
"operationId": "58e855a0c8cb230790062bc8",
"summary": "UpdateTag",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id this tag belongs to",
"required": true,
"type": "string"
},
{
"name": "tagId",
"in": "path",
"description": "Format - uuid. The id of the tag to update",
"required": true,
"type": "string"
},
{
"name": "imageTagModel",
"in": "body",
"schema": {
"$ref": "#/definitions/ImageTagModel"
},
"description": "The updated tag model"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageTagModel"
},
"examples": {
"application/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
},
"text/json": {
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
},
"application/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n"
}
}
}
}
},
"/account": {
"get": {
"operationId": "58d5835bc8cb231380095bde",
"summary": "GetAccountInfo",
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AccountModel"
},
"examples": {
"application/json": {
"UserName": "string",
"Email": "string",
"Keys": {
"TrainingKeys": {
"PrimaryKey": "string",
"SecondaryKey": "string"
},
"PredictionKeys": {
"PrimaryKey": "string",
"SecondaryKey": "string"
}
},
"Quotas": {
"Tier": "string",
"Projects": {
"Total": 0,
"Used": 0,
"TimeUntilReset": "string"
},
"Predictions": {
"Total": 0,
"Used": 0,
"TimeUntilReset": "string"
},
"PerProject": [
{
"ProjectId": "string",
"Iterations": {
"Total": 0,
"Used": 0,
"TimeUntilReset": "string"
},
"Images": {
"Total": 0,
"Used": 0,
"TimeUntilReset": "string"
},
"Tags": {
"Total": 0,
"Used": 0,
"TimeUntilReset": "string"
}
}
]
}
},
"text/json": {
"UserName": "string",
"Email": "string",
"Keys": {
"TrainingKeys": {
"PrimaryKey": "string",
"SecondaryKey": "string"
},
"PredictionKeys": {
"PrimaryKey": "string",
"SecondaryKey": "string"
}
},
"Quotas": {
"Tier": "string",
"Projects": {
"Total": 0,
"Used": 0,
"TimeUntilReset": "string"
},
"Predictions": {
"Total": 0,
"Used": 0,
"TimeUntilReset": "string"
},
"PerProject": [
{
"ProjectId": "string",
"Iterations": {
"Total": 0,
"Used": 0,
"TimeUntilReset": "string"
},
"Images": {
"Total": 0,
"Used": 0,
"TimeUntilReset": "string"
},
"Tags": {
"Total": 0,
"Used": 0,
"TimeUntilReset": "string"
}
}
]
}
},
"application/xml": "\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n \r\n \r\n \r\n string\r\n \r\n 0\r\n 0\r\n string\r\n \r\n \r\n 0\r\n 0\r\n string\r\n \r\n \r\n string\r\n \r\n 0\r\n 0\r\n string\r\n \r\n \r\n 0\r\n 0\r\n string\r\n \r\n \r\n 0\r\n 0\r\n string\r\n \r\n \r\n \r\n",
"text/xml": "\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n \r\n \r\n \r\n string\r\n \r\n 0\r\n 0\r\n string\r\n \r\n \r\n 0\r\n 0\r\n string\r\n \r\n \r\n string\r\n \r\n 0\r\n 0\r\n string\r\n \r\n \r\n 0\r\n 0\r\n string\r\n \r\n \r\n 0\r\n 0\r\n string\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/images/tagged/all": {
"get": {
"description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\nIf the total number of images is less than ({skip} + {take})\nthe number of images returned will be less than {take}.",
"operationId": "58d5835bc8cb231380095be0",
"summary": "GetAllTaggedImages",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration id. This will default to the current iteration",
"type": "string"
},
{
"name": "orderBy",
"in": "query",
"description": "The ordering. Defaults to newest",
"type": "string",
"enum": [
"Newest",
"Oldest"
]
},
{
"name": "take",
"in": "query",
"description": "Format - int32. Maximum number of images to return. Defaults to 50",
"type": "integer",
"default": 50
},
{
"name": "skip",
"in": "query",
"description": "Format - int32. How many images should be skipped before begining the image batch. Defaults to 0",
"type": "integer",
"default": 0
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageModelArray"
},
"examples": {
"application/json": [
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
],
"text/json": [
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
],
"application/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n",
"text/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/images/untagged": {
"get": {
"description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\nIf the total number of images is less than ({skip} + {take})\nthe number of images returned will be less than {take}.",
"operationId": "58d5835bc8cb231380095be1",
"summary": "GetAllUntaggedImages",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration id. This will default to the current iteration",
"type": "string"
},
{
"name": "orderBy",
"in": "query",
"description": "The ordering. Defaults to newest",
"type": "string",
"enum": [
"Newest",
"Oldest"
]
},
{
"name": "take",
"in": "query",
"description": "Format - int32. Maximum number of images to return. Defaults to 50",
"type": "integer",
"default": 50
},
{
"name": "skip",
"in": "query",
"description": "Format - int32. How many images should be skipped before begining the image batch. Defaults to 0",
"type": "integer",
"default": 0
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageModelArray"
},
"examples": {
"application/json": [
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
],
"text/json": [
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
],
"application/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n",
"text/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n"
}
}
}
}
},
"/domains/{domainId}": {
"get": {
"description": "Gets information about a specific domain",
"operationId": "58f13342c8cb230790062c90",
"summary": "GetDomain",
"parameters": [
{
"name": "domainId",
"in": "path",
"description": "Format - uuid. The id of the domain to get information about",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DomainModel"
},
"examples": {
"application/json": {
"Id": "string",
"Name": "string"
},
"text/json": {
"Id": "string",
"Name": "string"
},
"application/xml": "\r\n string\r\n string\r\n",
"text/xml": "\r\n string\r\n string\r\n"
}
}
}
}
},
"/domains": {
"get": {
"description": "Get a list of the avaiable domains",
"operationId": "58f13342c8cb230790062c8f",
"summary": "GetDomains",
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DomainModelArray"
},
"examples": {
"application/json": [
{
"Id": "string",
"Name": "string"
}
],
"text/json": [
{
"Id": "string",
"Name": "string"
}
],
"application/xml": "\r\n string\r\n string\r\n",
"text/xml": "\r\n string\r\n string\r\n"
}
}
}
}
},
"/projects/{projectId}/images/tagged": {
"get": {
"description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\nIf the total number of images is less than ({skip} + {take})\nthe number of images returned will be less than {take}.",
"operationId": "58d5835bc8cb231380095bdf",
"summary": "GetImagesByTags",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration id. This will default to the current iteration",
"type": "string"
},
{
"name": "tagIds",
"in": "query",
"description": "An required list of tags ids to filter the images. For example, if the provided tag ids are for the \"Dog\" and\r\n \"Cat\" tags, then only images tagged with Dog OR Cat will be returned. Otherwise, all tagged images will be returned.",
"type": "array"
},
{
"name": "orderBy",
"in": "query",
"description": "The ordering. Defaults to newest",
"type": "string",
"enum": [
"Newest",
"Oldest"
]
},
{
"name": "take",
"in": "query",
"description": "Format - int32. Maximum number of images to return. Defaults to 50",
"type": "integer",
"default": 50
},
{
"name": "skip",
"in": "query",
"description": "Format - int32. How many images should be skipped before begining the image batch. Defaults to 0",
"type": "integer",
"default": 0
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageModelArray"
},
"examples": {
"application/json": [
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
],
"text/json": [
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
],
"application/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n",
"text/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/iterations/{iterationId}/performance": {
"get": {
"description": "Get detailed performance information about an iteration",
"operationId": "590174bdc8cb2315f48693e0",
"summary": "GetIterationPerformance",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The id of the project the iteration belongs to",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. The id of the iteration to get",
"required": true,
"type": "string"
},
{
"name": "threshold",
"in": "query",
"description": "Format - float. The threshold threshold used to determine positive predictions",
"required": true,
"type": "number"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IterationPerformanceModel"
},
"examples": {
"application/json": {
"PerTagPerformance": [
{
"TagId": "string",
"TagName": "string",
"Precision": 0.0,
"PrecisionStdDeviation": 0.0,
"Recall": 0.0,
"RecallStdDeviation": 0.0
}
],
"Precision": 0.0,
"PrecisionStdDeviation": 0.0,
"Recall": 0.0,
"RecallStdDeviation": 0.0
},
"text/json": {
"PerTagPerformance": [
{
"TagId": "string",
"TagName": "string",
"Precision": 0.0,
"PrecisionStdDeviation": 0.0,
"Recall": 0.0,
"RecallStdDeviation": 0.0
}
],
"Precision": 0.0,
"PrecisionStdDeviation": 0.0,
"Recall": 0.0,
"RecallStdDeviation": 0.0
},
"application/xml": "\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n",
"text/xml": "\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n"
}
}
}
}
},
"/projects/{projectId}/iterations": {
"get": {
"description": "Get iterations for the project",
"operationId": "58d5835bc8cb231380095bee",
"summary": "GetIterations",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IterationModelArray"
},
"examples": {
"application/json": [
{
"Id": "string",
"Name": "string",
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"IsDefault": true
}
],
"text/json": [
{
"Id": "string",
"Name": "string",
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"IsDefault": true
}
],
"application/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n"
}
}
}
}
},
"/projects/{projectId}/predictions/next": {
"post": {
"operationId": "58f4fa2ec8cb230790062d38",
"summary": "GetNextPredictionResults",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid.",
"required": true,
"type": "string"
},
{
"name": "predictionQueryTokenModel",
"in": "body",
"schema": {
"$ref": "#/definitions/PredictionQueryTokenModel"
}
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PredictionQueryModel"
},
"examples": {
"application/json": {
"Results": [
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
],
"ImageUri": "string",
"ThumbnailUri": "string"
}
],
"Token": {
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"IterationId": "string",
"TagIds": [
"string"
],
"Threshold": 0.0,
"StartTime": "string",
"EndTime": "string",
"Source": "string"
}
},
"text/json": {
"Results": [
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
],
"ImageUri": "string",
"ThumbnailUri": "string"
}
],
"Token": {
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"IterationId": "string",
"TagIds": [
"string"
],
"Threshold": 0.0,
"StartTime": "string",
"EndTime": "string",
"Source": "string"
}
},
"application/xml": "\r\n \r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n string\r\n 0\r\n \r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n Newest\r\n string\r\n string\r\n 0\r\n string\r\n string\r\n \r\n \r\n",
"text/xml": "\r\n \r\n string\r\n string\r\n string\r\n string\r\n \r\n string\r\n string\r\n 0\r\n \r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n Newest\r\n string\r\n string\r\n 0\r\n string\r\n string\r\n \r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/images/{imageId}/label": {
"post": {
"description": "Post a label to a specific image",
"operationId": "58f4fa2ec8cb230790062d35",
"summary": "PostImageLabel",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. Guid of projectId",
"required": true,
"type": "string"
},
{
"name": "imageId",
"in": "path",
"description": "Format - uuid. Guid of imageId",
"required": true,
"type": "string"
},
{
"name": "tagId",
"in": "query",
"description": "Format - uuid. Guid of the tag to create this label for",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageModel"
},
"examples": {
"application/json": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
},
"text/json": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Labels": [
{
"LabelId": "string",
"Created": "string",
"TagId": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
},
"application/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n",
"text/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n 0\r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/train": {
"post": {
"description": "Queues training of the current iteration for the project",
"operationId": "58d5835bc8cb231380095bed",
"summary": "TrainProject",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IterationModel"
},
"examples": {
"application/json": {
"Id": "string",
"Name": "string",
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"IsDefault": true
},
"text/json": {
"Id": "string",
"Name": "string",
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"IsDefault": true
},
"application/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n"
}
}
}
}
}
},
"definitions": {
"AccountModel": {
"description": "Represents a user account",
"type": "object",
"properties": {
"UserName": {
"description": "Gets the name of the account owner",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Email": {
"description": "Gets the email associated with this account",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Keys": {
"$ref": "#/definitions/ApiKeysModel",
"description": "Gets the api keys associated with this account",
"readOnly": true
},
"Quotas": {
"$ref": "#/definitions/AccountQuotaModel",
"description": "Gets the quotas associated with this account",
"readOnly": true
}
},
"x-nullable": true
},
"ApiKeysModel": {
"type": "object",
"properties": {
"TrainingKeys": {
"$ref": "#/definitions/KeyPairModel"
},
"PredictionKeys": {
"$ref": "#/definitions/KeyPairModel"
}
},
"x-nullable": true
},
"AccountQuotaModel": {
"description": "Represents a set of quotas assocated with an account",
"type": "object",
"properties": {
"Tier": {
"description": "Gets the tier of user",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Projects": {
"$ref": "#/definitions/QuotaModel",
"description": "Gets the project quota",
"readOnly": true
},
"Predictions": {
"$ref": "#/definitions/QuotaModel",
"description": "Gets the prediction quota",
"readOnly": true
},
"PerProject": {
"description": "Gets a list of quotas that apply per-project for each project",
"type": "array",
"items": {
"$ref": "#/definitions/PerProjectQuotaModel"
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"KeyPairModel": {
"type": "object",
"properties": {
"PrimaryKey": {
"type": "string",
"x-nullable": true
},
"SecondaryKey": {
"type": "string",
"x-nullable": true
}
},
"x-nullable": true
},
"QuotaModel": {
"description": "Represents a quota",
"type": "object",
"properties": {
"Total": {
"format": "int32",
"description": "The total allowable amount in the quota",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"Used": {
"format": "int32",
"description": "The amount of quota that has currently been used",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"TimeUntilReset": {
"format": "duration",
"description": "Gets the time remaining until the quota resets. Null if this quota does not reset.",
"type": "string",
"x-nullable": true
}
},
"x-nullable": true
},
"PerProjectQuotaModel": {
"description": "Represents a set of quotas for a given project",
"type": "object",
"properties": {
"ProjectId": {
"format": "uuid",
"description": "Gets the project id of the project this quota applies to",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Iterations": {
"$ref": "#/definitions/QuotaModel",
"description": "Gets the iteration quota for the project",
"readOnly": true
},
"Images": {
"$ref": "#/definitions/QuotaModel",
"description": "Gets the image quota for the project",
"readOnly": true
},
"Tags": {
"$ref": "#/definitions/QuotaModel",
"description": "Gets the tag quota for the project",
"readOnly": true
}
},
"x-nullable": true
},
"DomainModel": {
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Name": {
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"ImageModel": {
"description": "Image model to be sent as JSON",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Width": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"Height": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"ImageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"ThumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Labels": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageLabelModel"
},
"readOnly": true,
"x-nullable": true
},
"Predictions": {
"type": "array",
"items": {
"$ref": "#/definitions/PredictionTagModel"
},
"x-nullable": true
}
},
"x-nullable": true
},
"ImageLabelModel": {
"type": "object",
"properties": {
"LabelId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"TagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"PredictionTagModel": {
"type": "object",
"properties": {
"TagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Tag": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Probability": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"ImageUrlCreateBatch": {
"type": "object",
"properties": {
"TagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"x-nullable": true
},
"Urls": {
"type": "array",
"items": {
"type": "string",
"x-nullable": true
},
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"TagIds": [
"string"
],
"Urls": [
"string"
]
}
},
"CreateImageSummaryModel": {
"type": "object",
"properties": {
"IsBatchSuccessful": {
"type": "boolean",
"x-nullable": false
},
"Images": {
"type": "array",
"items": {
"$ref": "#/definitions/CreateImageResultModel"
},
"x-nullable": true
}
},
"x-nullable": true
},
"CreateImageResultModel": {
"type": "object",
"properties": {
"SourceUrl": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Image": {
"$ref": "#/definitions/ImageModel",
"readOnly": true
},
"Status": {
"enum": [
"OK",
"OKDuplicate",
"ErrorSource",
"ErrorImageFormat",
"ErrorImageSize",
"ErrorStorage",
"ErrorLimitExceed",
"ErrorUnknown"
],
"type": "string",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"ImageIdCreateBatch": {
"type": "object",
"properties": {
"TagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"x-nullable": true
},
"Ids": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"TagIds": [
"string"
],
"Ids": [
"string"
]
}
},
"PredictionQueryModel": {
"type": "object",
"properties": {
"Results": {
"type": "array",
"items": {
"$ref": "#/definitions/PredictionModel"
},
"readOnly": true,
"x-nullable": true
},
"Token": {
"$ref": "#/definitions/PredictionQueryTokenModel",
"readOnly": true
}
},
"x-nullable": true
},
"PredictionModel": {
"description": "result of an image classification request",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Project": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Iteration": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Predictions": {
"type": "array",
"items": {
"$ref": "#/definitions/PredictionTagModel"
},
"readOnly": true,
"x-nullable": true
},
"ImageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"ThumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"PredictionQueryTokenModel": {
"type": "object",
"properties": {
"Session": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Continuation": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"MaxCount": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"OrderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"readOnly": true,
"x-nullable": false
},
"IterationId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"TagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"readOnly": true,
"x-nullable": true
},
"Threshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"StartTime": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"EndTime": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Source": {
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"IterationId": "string",
"TagIds": [
"string"
],
"Threshold": 0.0,
"StartTime": "string",
"EndTime": "string",
"Source": "string"
}
},
"ProjectModel": {
"description": "Represents a project",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"description": "Gets the project id",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Name": {
"description": "Gets or sets the name of the project",
"type": "string",
"x-nullable": true
},
"Description": {
"description": "Gets or sets the description of the project",
"type": "string",
"x-nullable": true
},
"CurrentIterationId": {
"format": "uuid",
"description": "Gets the current iteration id",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Created": {
"format": "date-time",
"description": "Gets the date this project was created",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"LastModified": {
"format": "date-time",
"description": "Gets the date this project was last modifed",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Settings": {
"$ref": "#/definitions/ProjectSettingsModel",
"description": "Gets or sets the project settings"
},
"ThumbnailUri": {
"description": "Gets the thumbnail url representing the image",
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"Id": "string",
"Name": "string",
"Description": "string",
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"Settings": {
"DomainId": "string"
},
"ThumbnailUri": "string"
}
},
"ProjectSettingsModel": {
"description": "Represents settings associated with a project",
"type": "object",
"properties": {
"DomainId": {
"format": "uuid",
"description": "Gets or sets the id of the Domain to use with this project",
"type": "string",
"x-nullable": false
}
},
"x-nullable": true
},
"IterationModel": {
"description": "Iteration model to be sent over JSON",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"description": "Gets the id of the iteration",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Name": {
"description": "Gets or sets the name of the iteration",
"type": "string",
"x-nullable": true
},
"Status": {
"description": "Gets the current iteration status",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Created": {
"format": "date-time",
"description": "Gets the time this iteration was completed",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"LastModified": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"TrainedAt": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"IsDefault": {
"description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
"type": "boolean",
"x-nullable": false
}
},
"x-nullable": true,
"example": {
"Id": "string",
"Name": "string",
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"IsDefault": true
}
},
"IterationPerformanceModel": {
"description": "Represents the detailed performance data for a trained iteration",
"type": "object",
"properties": {
"PerTagPerformance": {
"description": "Gets the per-tag performance details for this iteration",
"type": "array",
"items": {
"$ref": "#/definitions/ImageTagPerformanceModel"
},
"readOnly": true,
"x-nullable": true
},
"Precision": {
"format": "double",
"description": "Gets the precision",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"PrecisionStdDeviation": {
"format": "double",
"description": "Gets the standard deviation for the precision",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"Recall": {
"format": "double",
"description": "Gets the recall",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"RecallStdDeviation": {
"format": "double",
"description": "Gets the standard deviation for the recall",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"ImageTagPerformanceModel": {
"description": "Represents performance data for a particular tag in a trained iteration",
"type": "object",
"properties": {
"TagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"TagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Precision": {
"format": "double",
"description": "Gets the precision",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"PrecisionStdDeviation": {
"format": "double",
"description": "Gets the standard deviation for the precision",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"Recall": {
"format": "double",
"description": "Gets the recall",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"RecallStdDeviation": {
"format": "double",
"description": "Gets the standard deviation for the recall",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"ImageTagListModel": {
"type": "object",
"properties": {
"Tags": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageTagModel"
},
"readOnly": true,
"x-nullable": true
},
"TotalTaggedImages": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"TotalUntaggedImages": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"ImageTagModel": {
"description": "Represents a Tag",
"type": "object",
"properties": {
"Id": {
"format": "uuid",
"description": "Gets the Tag ID",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Name": {
"description": "Gets or sets the name of the tag",
"type": "string",
"x-nullable": true
},
"Description": {
"description": "Gets or sets the description of the tag",
"type": "string",
"x-nullable": true
},
"ImageCount": {
"format": "int32",
"description": "Gets the number of images labelled with this tag",
"type": "integer",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true,
"example": {
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
},
"DomainModelArray": {
"type": "array",
"items": {
"$ref": "#/definitions/DomainModel"
},
"x-nullable": true
},
"ImageModelArray": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageModel"
},
"x-nullable": true
},
"ProjectModelArray": {
"type": "array",
"items": {
"$ref": "#/definitions/ProjectModel"
},
"x-nullable": true
},
"IterationModelArray": {
"type": "array",
"items": {
"$ref": "#/definitions/IterationModel"
},
"x-nullable": true
}
},
"tags": []
}