This API accepts body content as multipart/form-data and application/octet-stream. When using multipart
multiple image files can be sent at once, with a maximum of 64 files
Format - uuid. The project id
The tags ids with which to tag each image. Limited to 20
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Add the provided batch of images to the set of training images
Format - uuid. The project id
The batch of image files to add. Limited to 64 images and 20 tags per batch
{
"Images": [
{
"Name": "string",
"Contents": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
{
"Images": [
{
"Name": "string",
"Contents": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
<ImageFileCreateBatch>
<Images>
<Name>string</Name>
<Contents>string</Contents>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageFileCreateBatch>
<ImageFileCreateBatch>
<Images>
<Name>string</Name>
<Contents>string</Contents>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageFileCreateBatch>
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Add the specified predicted images to the set of training images
Format - uuid. The project id
Image and tag ids. Limted to 64 images and 20 tags per batch
{
"Images": [
{
"Id": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
{
"Images": [
{
"Id": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
<ImageIdCreateBatch>
<Images>
<Id>string</Id>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageIdCreateBatch>
<ImageIdCreateBatch>
<Images>
<Id>string</Id>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageIdCreateBatch>
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Add the provided images urls to the set of training images
Format - uuid. The project id
Image urls and tag ids. Limited to 64 images and 20 tags per batch
{
"Images": [
{
"Url": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
{
"Images": [
{
"Url": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
<ImageUrlCreateBatch>
<Images>
<Url>string</Url>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageUrlCreateBatch>
<ImageUrlCreateBatch>
<Images>
<Url>string</Url>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageUrlCreateBatch>
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Create a project
The description of the project
Format - uuid. The id of the domain to use for this project. Defaults to General
Name of the project
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
Create a tag for the project
Format - uuid. The project id
Optional description for the tag
The tag name
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
Delete images from the set of training images
Format - uuid. The project id
Ids of the images to be deleted. Limted to 256 images per batch
No Content
Remove a set of tags from a set of images
Format - uuid. The project id
Image ids. Limited to 64 images
Tags to be deleted from the specified images. Limted to 20 tags
No Content
Delete a specific iteration of a project
Format - uuid. The project id
Format - uuid. The iteration id
No Content
Delete a set of predicted images and their associated prediction results
Format - uuid. The project id
The prediction ids. Limited to 64
No Content
Delete a specific project
Format - uuid. The project id
No Content
Delete a tag from the project
Format - uuid. The project id
Format - uuid. Id of the tag to be deleted
No Content
Export a trained iteration
Format - uuid. The project id
Format - uuid. The iteration id
The target platform (coreml or tensorflow)
OK
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
<Export>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</Export>
<Export>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</Export>
Get basic information about your account
OK
{
"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"
}
}
]
}
}
{
"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"
}
}
]
}
}
<Account>
<UserName>string</UserName>
<Email>string</Email>
<Keys>
<TrainingKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</TrainingKeys>
<PredictionKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</PredictionKeys>
</Keys>
<Quotas>
<Tier>string</Tier>
<Projects>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Projects>
<Predictions>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Predictions>
<PerProject>
<ProjectId>string</ProjectId>
<Iterations>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Iterations>
<Images>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Images>
<Tags>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Tags>
</PerProject>
</Quotas>
</Account>
<Account>
<UserName>string</UserName>
<Email>string</Email>
<Keys>
<TrainingKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</TrainingKeys>
<PredictionKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</PredictionKeys>
</Keys>
<Quotas>
<Tier>string</Tier>
<Projects>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Projects>
<Predictions>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Predictions>
<PerProject>
<ProjectId>string</ProjectId>
<Iterations>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Iterations>
<Images>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Images>
<Tags>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Tags>
</PerProject>
</Quotas>
</Account>
Get information about a specific domain
Format - uuid. The id of the domain to get information about
OK
{
"Id": "string",
"Name": "string",
"Exportable": true
}
{
"Id": "string",
"Name": "string",
"Exportable": true
}
<Domain>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</Domain>
<Domain>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</Domain>
Get a list of the available domains
OK
[
{
"Id": "string",
"Name": "string",
"Exportable": true
}
]
[
{
"Id": "string",
"Name": "string",
"Exportable": true
}
]
<DomainArray>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</DomainArray>
<DomainArray>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</DomainArray>
Get the list of exports for a specific iteration
Format - uuid. The project id
Format - uuid. The iteration id
OK
[
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
]
[
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
]
<ExportArray>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</ExportArray>
<ExportArray>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</ExportArray>
Get a specific iteration
Format - uuid. The id of the project the iteration belongs to
Format - uuid. The id of the iteration to get
OK
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
Get detailed performance information about a trained iteration
Format - uuid. The project id
Format - uuid. The id of the trained iteration
Format - float. The 0 to 1 threshold to determine positive prediction
OK
{
"PerTagPerformance": [
{
"Id": "string",
"Name": "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
}
{
"PerTagPerformance": [
{
"Id": "string",
"Name": "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
}
<IterationPerformance>
<PerTagPerformance>
<Id>string</Id>
<Name>string</Name>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</PerTagPerformance>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</IterationPerformance>
<IterationPerformance>
<PerTagPerformance>
<Id>string</Id>
<Name>string</Name>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</PerTagPerformance>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</IterationPerformance>
Get iterations for the project
Format - uuid. The project id
OK
[
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
]
[
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
]
<IterationArray>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</IterationArray>
<IterationArray>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</IterationArray>
Get a specific project
Format - uuid. The id of the project to get
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
Get your projects
OK
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
]
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
]
<ProjectArray>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</ProjectArray>
<ProjectArray>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</ProjectArray>
Get information about a specific tag
Format - uuid. The project this tag belongs to
Format - uuid. The tag id
Format - uuid. The iteration to retrieve this tag from. Optional, defaults to current training set
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
This API supports batching and range selection. By default it will only return first 50 images matching images.
Use the {take} and {skip} parameters to control how many images to return in a given batch.
The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and
"Cat" tags, then only images tagged with Dog and/or Cat will be returned
Format - uuid. The project id
Format - uuid. The iteration id. Defaults to workspace
An list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20
The ordering. Defaults to newest
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0
OK
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
Get the tags for a given project and iteration
Format - uuid. The project id
Format - uuid. The iteration id. Defaults to workspace
OK
{
"Tags": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
],
"TotalTaggedImages": 0,
"TotalUntaggedImages": 0
}
{
"Tags": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
],
"TotalTaggedImages": 0,
"TotalUntaggedImages": 0
}
<TagList>
<Tags>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tags>
<TotalTaggedImages>0</TotalTaggedImages>
<TotalUntaggedImages>0</TotalUntaggedImages>
</TagList>
<TagList>
<Tags>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tags>
<TotalTaggedImages>0</TotalTaggedImages>
<TotalUntaggedImages>0</TotalUntaggedImages>
</TagList>
This API supports batching and range selection. By default it will only return first 50 images matching images.
Use the {take} and {skip} parameters to control how many images to return in a given batch.
Format - uuid. The project id
Format - uuid. The iteration id. Defaults to workspace
The ordering. Defaults to newest
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0
OK
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
Associate a set of images with a set of tags
Format - uuid. The project id
Batch of image tags. Limited to 128 tags per batch
{
"Tags": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
{
"Tags": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
<ImageTagCreateBatch>
<Tags>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Tags>
</ImageTagCreateBatch>
<ImageTagCreateBatch>
<Tags>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Tags>
</ImageTagCreateBatch>
OK
{
"Created": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Duplicated": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Exceeded": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
{
"Created": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Duplicated": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Exceeded": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
<ImageTagCreateSummary>
<Created>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Created>
<Duplicated>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Duplicated>
<Exceeded>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Exceeded>
</ImageTagCreateSummary>
<ImageTagCreateSummary>
<Created>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Created>
<Duplicated>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Duplicated>
<Exceeded>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Exceeded>
</ImageTagCreateSummary>
Get images that were sent to your prediction endpoint
Format - uuid. The project id
Parameters used to query the predictions. Limited to combining 2 tags
{
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
{
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
<PredictionQueryToken>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</PredictionQueryToken>
<PredictionQueryToken>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</PredictionQueryToken>
OK
{
"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",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
}
{
"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",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
}
<PredictionQuery>
<Results>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
</Results>
<Token>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</Token>
</PredictionQuery>
<PredictionQuery>
<Results>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
</Results>
<Token>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</Token>
</PredictionQuery>
Quick test an image
Format - uuid. The project id
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
OK
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
Quick test an image url
Format - uuid. The project to evaluate against
An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
{
"Url": "string"
}
{
"Url": "string"
}
<ImageUrl>
<Url>string</Url>
</ImageUrl>
<ImageUrl>
<Url>string</Url>
</ImageUrl>
OK
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
Queues project for training
Format - uuid. The project id
OK
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
Update a specific iteration
Format - uuid. Project id
Format - uuid. Iteration id
The updated iteration model
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
OK
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
Update a specific project
Format - uuid. The id of the project to update
The updated project model
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
Update a tag
Format - uuid. The project id
Format - uuid. The id of the target tag
The updated tag model
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
This API accepts body content as multipart/form-data and application/octet-stream. When using multipart
multiple image files can be sent at once, with a maximum of 64 files
Format - uuid. The project id
The tags ids with which to tag each image. Limited to 20
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Add the provided batch of images to the set of training images
Format - uuid. The project id
The batch of image files to add. Limited to 64 images and 20 tags per batch
{
"Images": [
{
"Name": "string",
"Contents": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
{
"Images": [
{
"Name": "string",
"Contents": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
<ImageFileCreateBatch>
<Images>
<Name>string</Name>
<Contents>string</Contents>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageFileCreateBatch>
<ImageFileCreateBatch>
<Images>
<Name>string</Name>
<Contents>string</Contents>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageFileCreateBatch>
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Add the specified predicted images to the set of training images
Format - uuid. The project id
Image and tag ids. Limted to 64 images and 20 tags per batch
{
"Images": [
{
"Id": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
{
"Images": [
{
"Id": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
<ImageIdCreateBatch>
<Images>
<Id>string</Id>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageIdCreateBatch>
<ImageIdCreateBatch>
<Images>
<Id>string</Id>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageIdCreateBatch>
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Add the provided images urls to the set of training images
Format - uuid. The project id
Image urls and tag ids. Limited to 64 images and 20 tags per batch
{
"Images": [
{
"Url": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
{
"Images": [
{
"Url": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
<ImageUrlCreateBatch>
<Images>
<Url>string</Url>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageUrlCreateBatch>
<ImageUrlCreateBatch>
<Images>
<Url>string</Url>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageUrlCreateBatch>
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Create a project
The description of the project
Format - uuid. The id of the domain to use for this project. Defaults to General
Name of the project
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
Create a tag for the project
Format - uuid. The project id
Optional description for the tag
The tag name
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
Delete images from the set of training images
Format - uuid. The project id
Ids of the images to be deleted. Limted to 256 images per batch
No Content
Remove a set of tags from a set of images
Format - uuid. The project id
Image ids. Limited to 64 images
Tags to be deleted from the specified images. Limted to 20 tags
No Content
Delete a specific iteration of a project
Format - uuid. The project id
Format - uuid. The iteration id
No Content
Delete a set of predicted images and their associated prediction results
Format - uuid. The project id
The prediction ids. Limited to 64
No Content
Delete a specific project
Format - uuid. The project id
No Content
Delete a tag from the project
Format - uuid. The project id
Format - uuid. Id of the tag to be deleted
No Content
Export a trained iteration
Format - uuid. The project id
Format - uuid. The iteration id
The target platform (coreml or tensorflow)
OK
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
<Export>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</Export>
<Export>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</Export>
Get basic information about your account
OK
{
"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"
}
}
]
}
}
{
"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"
}
}
]
}
}
<Account>
<UserName>string</UserName>
<Email>string</Email>
<Keys>
<TrainingKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</TrainingKeys>
<PredictionKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</PredictionKeys>
</Keys>
<Quotas>
<Tier>string</Tier>
<Projects>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Projects>
<Predictions>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Predictions>
<PerProject>
<ProjectId>string</ProjectId>
<Iterations>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Iterations>
<Images>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Images>
<Tags>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Tags>
</PerProject>
</Quotas>
</Account>
<Account>
<UserName>string</UserName>
<Email>string</Email>
<Keys>
<TrainingKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</TrainingKeys>
<PredictionKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</PredictionKeys>
</Keys>
<Quotas>
<Tier>string</Tier>
<Projects>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Projects>
<Predictions>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Predictions>
<PerProject>
<ProjectId>string</ProjectId>
<Iterations>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Iterations>
<Images>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Images>
<Tags>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Tags>
</PerProject>
</Quotas>
</Account>
Get information about a specific domain
Format - uuid. The id of the domain to get information about
OK
{
"Id": "string",
"Name": "string",
"Exportable": true
}
{
"Id": "string",
"Name": "string",
"Exportable": true
}
<Domain>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</Domain>
<Domain>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</Domain>
Get a list of the available domains
OK
[
{
"Id": "string",
"Name": "string",
"Exportable": true
}
]
[
{
"Id": "string",
"Name": "string",
"Exportable": true
}
]
<DomainArray>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</DomainArray>
<DomainArray>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</DomainArray>
Get the list of exports for a specific iteration
Format - uuid. The project id
Format - uuid. The iteration id
OK
[
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
]
[
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
]
<ExportArray>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</ExportArray>
<ExportArray>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</ExportArray>
Get a specific iteration
Format - uuid. The id of the project the iteration belongs to
Format - uuid. The id of the iteration to get
OK
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
Get detailed performance information about a trained iteration
Format - uuid. The project id
Format - uuid. The id of the trained iteration
Format - float. The 0 to 1 threshold to determine positive prediction
OK
{
"PerTagPerformance": [
{
"Id": "string",
"Name": "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
}
{
"PerTagPerformance": [
{
"Id": "string",
"Name": "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
}
<IterationPerformance>
<PerTagPerformance>
<Id>string</Id>
<Name>string</Name>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</PerTagPerformance>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</IterationPerformance>
<IterationPerformance>
<PerTagPerformance>
<Id>string</Id>
<Name>string</Name>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</PerTagPerformance>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</IterationPerformance>
Get iterations for the project
Format - uuid. The project id
OK
[
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
]
[
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
]
<IterationArray>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</IterationArray>
<IterationArray>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</IterationArray>
Get a specific project
Format - uuid. The id of the project to get
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
Get your projects
OK
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
]
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
]
<ProjectArray>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</ProjectArray>
<ProjectArray>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</ProjectArray>
Get information about a specific tag
Format - uuid. The project this tag belongs to
Format - uuid. The tag id
Format - uuid. The iteration to retrieve this tag from. Optional, defaults to current training set
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
This API supports batching and range selection. By default it will only return first 50 images matching images.
Use the {take} and {skip} parameters to control how many images to return in a given batch.
The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and
"Cat" tags, then only images tagged with Dog and/or Cat will be returned
Format - uuid. The project id
Format - uuid. The iteration id. Defaults to workspace
An list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20
The ordering. Defaults to newest
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0
OK
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
Get the tags for a given project and iteration
Format - uuid. The project id
Format - uuid. The iteration id. Defaults to workspace
OK
{
"Tags": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
],
"TotalTaggedImages": 0,
"TotalUntaggedImages": 0
}
{
"Tags": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
],
"TotalTaggedImages": 0,
"TotalUntaggedImages": 0
}
<TagList>
<Tags>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tags>
<TotalTaggedImages>0</TotalTaggedImages>
<TotalUntaggedImages>0</TotalUntaggedImages>
</TagList>
<TagList>
<Tags>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tags>
<TotalTaggedImages>0</TotalTaggedImages>
<TotalUntaggedImages>0</TotalUntaggedImages>
</TagList>
This API supports batching and range selection. By default it will only return first 50 images matching images.
Use the {take} and {skip} parameters to control how many images to return in a given batch.
Format - uuid. The project id
Format - uuid. The iteration id. Defaults to workspace
The ordering. Defaults to newest
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0
OK
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
Associate a set of images with a set of tags
Format - uuid. The project id
Batch of image tags. Limited to 128 tags per batch
{
"Tags": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
{
"Tags": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
<ImageTagCreateBatch>
<Tags>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Tags>
</ImageTagCreateBatch>
<ImageTagCreateBatch>
<Tags>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Tags>
</ImageTagCreateBatch>
OK
{
"Created": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Duplicated": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Exceeded": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
{
"Created": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Duplicated": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Exceeded": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
<ImageTagCreateSummary>
<Created>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Created>
<Duplicated>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Duplicated>
<Exceeded>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Exceeded>
</ImageTagCreateSummary>
<ImageTagCreateSummary>
<Created>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Created>
<Duplicated>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Duplicated>
<Exceeded>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Exceeded>
</ImageTagCreateSummary>
Get images that were sent to your prediction endpoint
Format - uuid. The project id
Parameters used to query the predictions. Limited to combining 2 tags
{
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
{
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
<PredictionQueryToken>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</PredictionQueryToken>
<PredictionQueryToken>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</PredictionQueryToken>
OK
{
"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",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
}
{
"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",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
}
<PredictionQuery>
<Results>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
</Results>
<Token>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</Token>
</PredictionQuery>
<PredictionQuery>
<Results>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
</Results>
<Token>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</Token>
</PredictionQuery>
Quick test an image
Format - uuid. The project id
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
OK
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
Quick test an image url
Format - uuid. The project to evaluate against
An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
{
"Url": "string"
}
{
"Url": "string"
}
<ImageUrl>
<Url>string</Url>
</ImageUrl>
<ImageUrl>
<Url>string</Url>
</ImageUrl>
OK
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
Queues project for training
Format - uuid. The project id
OK
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
Update a specific iteration
Format - uuid. Project id
Format - uuid. Iteration id
The updated iteration model
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
OK
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
Update a specific project
Format - uuid. The id of the project to update
The updated project model
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
Update a tag
Format - uuid. The project id
Format - uuid. The id of the target tag
The updated tag model
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
This API accepts body content as multipart/form-data and application/octet-stream. When using multipart
multiple image files can be sent at once, with a maximum of 64 files
Format - uuid. The project id
The tags ids with which to tag each image. Limited to 20
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Add the provided batch of images to the set of training images
Format - uuid. The project id
The batch of image files to add. Limited to 64 images and 20 tags per batch
{
"Images": [
{
"Name": "string",
"Contents": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
{
"Images": [
{
"Name": "string",
"Contents": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
<ImageFileCreateBatch>
<Images>
<Name>string</Name>
<Contents>string</Contents>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageFileCreateBatch>
<ImageFileCreateBatch>
<Images>
<Name>string</Name>
<Contents>string</Contents>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageFileCreateBatch>
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Add the specified predicted images to the set of training images
Format - uuid. The project id
Image and tag ids. Limted to 64 images and 20 tags per batch
{
"Images": [
{
"Id": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
{
"Images": [
{
"Id": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
<ImageIdCreateBatch>
<Images>
<Id>string</Id>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageIdCreateBatch>
<ImageIdCreateBatch>
<Images>
<Id>string</Id>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageIdCreateBatch>
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Add the provided images urls to the set of training images
Format - uuid. The project id
Image urls and tag ids. Limited to 64 images and 20 tags per batch
{
"Images": [
{
"Url": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
{
"Images": [
{
"Url": "string",
"TagIds": [
"string"
]
}
],
"TagIds": [
"string"
]
}
<ImageUrlCreateBatch>
<Images>
<Url>string</Url>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageUrlCreateBatch>
<ImageUrlCreateBatch>
<Images>
<Url>string</Url>
<TagIds>string</TagIds>
</Images>
<TagIds>string</TagIds>
</ImageUrlCreateBatch>
OK
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
{
"IsBatchSuccessful": true,
"Images": [
{
"SourceUrl": "string",
"Status": "OK",
"Image": {
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
}
]
}
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
<ImageCreateSummary>
<IsBatchSuccessful>true</IsBatchSuccessful>
<Images>
<SourceUrl>string</SourceUrl>
<Status>OK</Status>
<Image>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</Image>
</Images>
</ImageCreateSummary>
Create a project
The description of the project
Format - uuid. The id of the domain to use for this project. Defaults to General
Name of the project
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
Create a tag for the project
Format - uuid. The project id
Optional description for the tag
The tag name
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
Delete images from the set of training images
Format - uuid. The project id
Ids of the images to be deleted. Limted to 256 images per batch
No Content
Remove a set of tags from a set of images
Format - uuid. The project id
Image ids. Limited to 64 images
Tags to be deleted from the specified images. Limted to 20 tags
No Content
Delete a specific iteration of a project
Format - uuid. The project id
Format - uuid. The iteration id
No Content
Delete a set of predicted images and their associated prediction results
Format - uuid. The project id
The prediction ids. Limited to 64
No Content
Delete a specific project
Format - uuid. The project id
No Content
Delete a tag from the project
Format - uuid. The project id
Format - uuid. Id of the tag to be deleted
No Content
Export a trained iteration
Format - uuid. The project id
Format - uuid. The iteration id
The target platform (coreml or tensorflow)
OK
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
<Export>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</Export>
<Export>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</Export>
Get basic information about your account
OK
{
"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"
}
}
]
}
}
{
"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"
}
}
]
}
}
<Account>
<UserName>string</UserName>
<Email>string</Email>
<Keys>
<TrainingKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</TrainingKeys>
<PredictionKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</PredictionKeys>
</Keys>
<Quotas>
<Tier>string</Tier>
<Projects>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Projects>
<Predictions>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Predictions>
<PerProject>
<ProjectId>string</ProjectId>
<Iterations>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Iterations>
<Images>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Images>
<Tags>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Tags>
</PerProject>
</Quotas>
</Account>
<Account>
<UserName>string</UserName>
<Email>string</Email>
<Keys>
<TrainingKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</TrainingKeys>
<PredictionKeys>
<PrimaryKey>string</PrimaryKey>
<SecondaryKey>string</SecondaryKey>
</PredictionKeys>
</Keys>
<Quotas>
<Tier>string</Tier>
<Projects>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Projects>
<Predictions>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Predictions>
<PerProject>
<ProjectId>string</ProjectId>
<Iterations>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Iterations>
<Images>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Images>
<Tags>
<Total>0</Total>
<Used>0</Used>
<TimeUntilReset>string</TimeUntilReset>
</Tags>
</PerProject>
</Quotas>
</Account>
Get information about a specific domain
Format - uuid. The id of the domain to get information about
OK
{
"Id": "string",
"Name": "string",
"Exportable": true
}
{
"Id": "string",
"Name": "string",
"Exportable": true
}
<Domain>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</Domain>
<Domain>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</Domain>
Get a list of the available domains
OK
[
{
"Id": "string",
"Name": "string",
"Exportable": true
}
]
[
{
"Id": "string",
"Name": "string",
"Exportable": true
}
]
<DomainArray>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</DomainArray>
<DomainArray>
<Id>string</Id>
<Name>string</Name>
<Exportable>true</Exportable>
</DomainArray>
Get the list of exports for a specific iteration
Format - uuid. The project id
Format - uuid. The iteration id
OK
[
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
]
[
{
"Platform": "CoreML",
"Status": "Exporting",
"DownloadUri": "string"
}
]
<ExportArray>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</ExportArray>
<ExportArray>
<Platform>CoreML</Platform>
<Status>Exporting</Status>
<DownloadUri>string</DownloadUri>
</ExportArray>
Get a specific iteration
Format - uuid. The id of the project the iteration belongs to
Format - uuid. The id of the iteration to get
OK
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
Get detailed performance information about a trained iteration
Format - uuid. The project id
Format - uuid. The id of the trained iteration
Format - float. The 0 to 1 threshold to determine positive prediction
OK
{
"PerTagPerformance": [
{
"Id": "string",
"Name": "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
}
{
"PerTagPerformance": [
{
"Id": "string",
"Name": "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
}
<IterationPerformance>
<PerTagPerformance>
<Id>string</Id>
<Name>string</Name>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</PerTagPerformance>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</IterationPerformance>
<IterationPerformance>
<PerTagPerformance>
<Id>string</Id>
<Name>string</Name>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</PerTagPerformance>
<Precision>0</Precision>
<PrecisionStdDeviation>0</PrecisionStdDeviation>
<Recall>0</Recall>
<RecallStdDeviation>0</RecallStdDeviation>
</IterationPerformance>
Get iterations for the project
Format - uuid. The project id
OK
[
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
]
[
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
]
<IterationArray>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</IterationArray>
<IterationArray>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</IterationArray>
Get a specific project
Format - uuid. The id of the project to get
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
Get your projects
OK
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
]
[
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
]
<ProjectArray>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</ProjectArray>
<ProjectArray>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</ProjectArray>
Get information about a specific tag
Format - uuid. The project this tag belongs to
Format - uuid. The tag id
Format - uuid. The iteration to retrieve this tag from. Optional, defaults to current training set
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
This API supports batching and range selection. By default it will only return first 50 images matching images.
Use the {take} and {skip} parameters to control how many images to return in a given batch.
The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and
"Cat" tags, then only images tagged with Dog and/or Cat will be returned
Format - uuid. The project id
Format - uuid. The iteration id. Defaults to workspace
An list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20
The ordering. Defaults to newest
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0
OK
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
Get the tags for a given project and iteration
Format - uuid. The project id
Format - uuid. The iteration id. Defaults to workspace
OK
{
"Tags": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
],
"TotalTaggedImages": 0,
"TotalUntaggedImages": 0
}
{
"Tags": [
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
],
"TotalTaggedImages": 0,
"TotalUntaggedImages": 0
}
<TagList>
<Tags>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tags>
<TotalTaggedImages>0</TotalTaggedImages>
<TotalUntaggedImages>0</TotalUntaggedImages>
</TagList>
<TagList>
<Tags>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tags>
<TotalTaggedImages>0</TotalTaggedImages>
<TotalUntaggedImages>0</TotalUntaggedImages>
</TagList>
This API supports batching and range selection. By default it will only return first 50 images matching images.
Use the {take} and {skip} parameters to control how many images to return in a given batch.
Format - uuid. The project id
Format - uuid. The iteration id. Defaults to workspace
The ordering. Defaults to newest
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0
OK
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
[
{
"Id": "string",
"Created": "string",
"Width": 0,
"Height": 0,
"ImageUri": "string",
"ThumbnailUri": "string",
"Tags": [
{
"TagId": "string",
"Created": "string"
}
],
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
]
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
<ImageArray>
<Id>string</Id>
<Created>string</Created>
<Width>0</Width>
<Height>0</Height>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
<Tags>
<TagId>string</TagId>
<Created>string</Created>
</Tags>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImageArray>
Associate a set of images with a set of tags
Format - uuid. The project id
Batch of image tags. Limited to 128 tags per batch
{
"Tags": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
{
"Tags": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
<ImageTagCreateBatch>
<Tags>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Tags>
</ImageTagCreateBatch>
<ImageTagCreateBatch>
<Tags>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Tags>
</ImageTagCreateBatch>
OK
{
"Created": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Duplicated": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Exceeded": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
{
"Created": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Duplicated": [
{
"ImageId": "string",
"TagId": "string"
}
],
"Exceeded": [
{
"ImageId": "string",
"TagId": "string"
}
]
}
<ImageTagCreateSummary>
<Created>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Created>
<Duplicated>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Duplicated>
<Exceeded>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Exceeded>
</ImageTagCreateSummary>
<ImageTagCreateSummary>
<Created>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Created>
<Duplicated>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Duplicated>
<Exceeded>
<ImageId>string</ImageId>
<TagId>string</TagId>
</Exceeded>
</ImageTagCreateSummary>
Get images that were sent to your prediction endpoint
Format - uuid. The project id
Parameters used to query the predictions. Limited to combining 2 tags
{
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
{
"Session": "string",
"Continuation": "string",
"MaxCount": 0,
"OrderBy": "Newest",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
<PredictionQueryToken>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</PredictionQueryToken>
<PredictionQueryToken>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</PredictionQueryToken>
OK
{
"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",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
}
{
"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",
"Tags": [
{
"Id": "string",
"MinThreshold": 0.0,
"MaxThreshold": 0.0
}
],
"IterationId": "string",
"StartTime": "string",
"EndTime": "string",
"Application": "string"
}
}
<PredictionQuery>
<Results>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
</Results>
<Token>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</Token>
</PredictionQuery>
<PredictionQuery>
<Results>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
<ImageUri>string</ImageUri>
<ThumbnailUri>string</ThumbnailUri>
</Results>
<Token>
<Session>string</Session>
<Continuation>string</Continuation>
<MaxCount>0</MaxCount>
<OrderBy>Newest</OrderBy>
<Tags>
<Id>string</Id>
<MinThreshold>0</MinThreshold>
<MaxThreshold>0</MaxThreshold>
</Tags>
<IterationId>string</IterationId>
<StartTime>string</StartTime>
<EndTime>string</EndTime>
<Application>string</Application>
</Token>
</PredictionQuery>
Quick test an image
Format - uuid. The project id
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
OK
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
Quick test an image url
Format - uuid. The project to evaluate against
An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
{
"Url": "string"
}
{
"Url": "string"
}
<ImageUrl>
<Url>string</Url>
</ImageUrl>
<ImageUrl>
<Url>string</Url>
</ImageUrl>
OK
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
{
"Id": "string",
"Project": "string",
"Iteration": "string",
"Created": "string",
"Predictions": [
{
"TagId": "string",
"Tag": "string",
"Probability": 0.0
}
]
}
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
<ImagePredictionResult>
<Id>string</Id>
<Project>string</Project>
<Iteration>string</Iteration>
<Created>string</Created>
<Predictions>
<TagId>string</TagId>
<Tag>string</Tag>
<Probability>0</Probability>
</Predictions>
</ImagePredictionResult>
Queues project for training
Format - uuid. The project id
OK
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
Update a specific iteration
Format - uuid. Project id
Format - uuid. Iteration id
The updated iteration model
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
OK
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
{
"Id": "string",
"Name": "string",
"IsDefault": true,
"Status": "string",
"Created": "string",
"LastModified": "string",
"TrainedAt": "string",
"ProjectId": "string",
"Exportable": true,
"DomainId": "string"
}
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
<Iteration>
<Id>string</Id>
<Name>string</Name>
<IsDefault>true</IsDefault>
<Status>string</Status>
<Created>string</Created>
<LastModified>string</LastModified>
<TrainedAt>string</TrainedAt>
<ProjectId>string</ProjectId>
<Exportable>true</Exportable>
<DomainId>string</DomainId>
</Iteration>
Update a specific project
Format - uuid. The id of the project to update
The updated project model
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"Settings": {
"DomainId": "string"
},
"CurrentIterationId": "string",
"Created": "string",
"LastModified": "string",
"ThumbnailUri": "string"
}
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
<Project>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<Settings>
<DomainId>string</DomainId>
</Settings>
<CurrentIterationId>string</CurrentIterationId>
<Created>string</Created>
<LastModified>string</LastModified>
<ThumbnailUri>string</ThumbnailUri>
</Project>
Update a tag
Format - uuid. The project id
Format - uuid. The id of the target tag
The updated tag model
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
OK
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
{
"Id": "string",
"Name": "string",
"Description": "string",
"ImageCount": 0
}
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>
<Tag>
<Id>string</Id>
<Name>string</Name>
<Description>string</Description>
<ImageCount>0</ImageCount>
</Tag>