Projects - Create

Service:

Cognitive Services - Custom Vision

API Version:

3.3

Create a project.

POST {Endpoint}/customvision/v3.3/training/projects?name={name}

With optional parameters:

POST {Endpoint}/customvision/v3.3/training/projects?name={name}&description={description}&domainId={domainId}&classificationType={classificationType}&targetExportPlatforms={targetExportPlatforms}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoints.
name	query	True	string	Name of the project.
classificationType	query		string	The type of classifier to create for this project.
description	query		string	The description of the project.
domainId	query		string uuid	The id of the domain to use for this project. Defaults to General.
targetExportPlatforms	query		string[]	List of platforms the trained model is intending exporting to.

Request Header

Name	Required	Type	Description
Training-Key	True	string

Responses

Name	Type	Description
200 OK	Project	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Error response Media Types: "application/json", "application/xml", "text/xml"

Security

Training-Key

Type: apiKey
In: header

Examples

Successful CreateProject request

Sample Request

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects?name=My New Project&description=A test project&domainId=ee85a74c-405e-4adc-bb47-ffa8ca0c9f31

Sample Response

Status code:

200

{
  "id": "bc3f7dad-5544-468c-8573-3ef04d55463e",
  "name": "My New Project",
  "description": "A test project",
  "settings": {
    "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31"
  },
  "created": "2017-12-18T05:43:18Z",
  "lastModified": "2017-12-18T05:43:18Z",
  "thumbnailUri": ""
}

Definitions

Name	Description
Classifier	Gets the classification type of the project.
CustomVisionError
CustomVisionErrorCodes	The error code.
ImageProcessingSettings	Represents image preprocessing settings used by image augmentation.
Project	Represents a project.
ProjectSettings	Represents settings associated with a project.
ProjectStatus	Gets the status of the project.
TargetExportPlatforms	A list of ExportPlatform that the trained model should be able to support.

Classifier

Gets the classification type of the project.

Name	Type	Description
Multiclass	string
Multilabel	string

CustomVisionError

Name	Type	Description
code	CustomVisionErrorCodes	The error code.
message	string	A message explaining the error reported by the service.

CustomVisionErrorCodes

The error code.

Name	Type	Description
BadRequest	string
BadRequestCannotMigrateProjectWithName	string
BadRequestClassificationTrainingValidationFailed	string
BadRequestCustomerManagedKeyRevoked	string
BadRequestDetectionTrainingNotAllowNegativeTag	string
BadRequestDetectionTrainingValidationFailed	string
BadRequestDomainNotSupportedForAdvancedTraining	string
BadRequestExceedIterationPerProjectLimit	string
BadRequestExceedProjectLimit	string
BadRequestExceedTagPerImageLimit	string
BadRequestExceedTagPerProjectLimit	string
BadRequestExceededBatchSize	string
BadRequestExceededQuota	string
BadRequestExportAlreadyInProgress	string
BadRequestExportPlatformNotSupportedForAdvancedTraining	string
BadRequestExportValidationFailed	string
BadRequestExportWhileTraining	string
BadRequestImageBatch	string
BadRequestImageDimensions	string
BadRequestImageExceededCount	string
BadRequestImageFormat	string
BadRequestImageMetadataKey	string
BadRequestImageMetadataValue	string
BadRequestImageRegions	string
BadRequestImageSizeBytes	string
BadRequestImageStream	string
BadRequestImageTags	string
BadRequestImageUrl	string
BadRequestInvalid	string
BadRequestInvalidArtifactUri	string
BadRequestInvalidEmailAddress	string
BadRequestInvalidIds	string
BadRequestInvalidImportToken	string
BadRequestInvalidPublishName	string
BadRequestInvalidPublishTarget	string
BadRequestIterationDescription	string
BadRequestIterationIsNotTrained	string
BadRequestIterationIsPublished	string
BadRequestIterationName	string
BadRequestIterationNameNotUnique	string
BadRequestIterationNotPublished	string
BadRequestIterationValidationFailed	string
BadRequestMultiClassClassificationTrainingValidationFailed	string
BadRequestMultiLabelClassificationTrainingValidationFailed	string
BadRequestMultipleGeneralProductTag	string
BadRequestMultipleNegativeTag	string
BadRequestNegativeAndRegularTagOnSameImage	string
BadRequestNotLimitedTrial	string
BadRequestNotSupported	string
BadRequestOperationNotSupported	string
BadRequestPredictionIdsExceededCount	string
BadRequestPredictionIdsMissing	string
BadRequestPredictionInvalidApplicationName	string
BadRequestPredictionInvalidQueryParameters	string
BadRequestPredictionResultsExceededCount	string
BadRequestPredictionTagsExceededCount	string
BadRequestProjectDescription	string
BadRequestProjectDuplicated	string
BadRequestProjectImagePreprocessingSettings	string
BadRequestProjectName	string
BadRequestProjectNameNotUnique	string
BadRequestProjectUnknownClassification	string
BadRequestProjectUnknownDomain	string
BadRequestProjectUnsupportedDomainTypeChange	string
BadRequestProjectUnsupportedExportPlatform	string
BadRequestRequiredParamIsNull	string
BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining	string
BadRequestSubscriptionApi	string
BadRequestTagDescription	string
BadRequestTagName	string
BadRequestTagNameNotUnique	string
BadRequestTagType	string
BadRequestTrainingAlreadyInProgress	string
BadRequestTrainingNotNeeded	string
BadRequestTrainingNotNeededButTrainingPipelineUpdated	string
BadRequestTrainingValidationFailed	string
BadRequestUnpublishFailed	string
BadRequestUnsupportedDomain	string
BadRequestWorkspaceCannotBeModified	string
BadRequestWorkspaceNotDeletable	string
Conflict	string
ConflictInvalid	string
ErrorExporterInvalidClassifier	string
ErrorExporterInvalidFeaturizer	string
ErrorExporterInvalidPlatform	string
ErrorFeaturizationAugmentationError	string
ErrorFeaturizationAugmentationUnavailable	string
ErrorFeaturizationInvalidFeaturizer	string
ErrorFeaturizationQueueTimeout	string
ErrorFeaturizationServiceUnavailable	string
ErrorFeaturizationUnrecognizedJob	string
ErrorInvalid	string
ErrorIterationCopyFailed	string
ErrorPrediction	string
ErrorPredictionModelNotCached	string
ErrorPredictionModelNotFound	string
ErrorPredictionServiceUnavailable	string
ErrorPredictionStorage	string
ErrorPreparePerformanceMigrationFailed	string
ErrorProjectExportRequestFailed	string
ErrorProjectImportRequestFailed	string
ErrorProjectInvalidDomain	string
ErrorProjectInvalidPipelineConfiguration	string
ErrorProjectInvalidWorkspace	string
ErrorProjectTrainingRequestFailed	string
ErrorRegionProposal	string
ErrorUnknown	string
ErrorUnknownBaseModel	string
Forbidden	string
ForbiddenDRModeEnabled	string
ForbiddenInvalid	string
ForbiddenUser	string
ForbiddenUserDisabled	string
ForbiddenUserDoesNotExist	string
ForbiddenUserInsufficientCapability	string
ForbiddenUserResource	string
ForbiddenUserSignupAllowanceExceeded	string
ForbiddenUserSignupDisabled	string
NoError	string
NotFound	string
NotFoundApimSubscription	string
NotFoundDomain	string
NotFoundImage	string
NotFoundInvalid	string
NotFoundIteration	string
NotFoundIterationPerformance	string
NotFoundProject	string
NotFoundProjectDefaultIteration	string
NotFoundTag	string
UnsupportedMediaType	string

ImageProcessingSettings

Represents image preprocessing settings used by image augmentation.

Name	Type	Description
augmentationMethods	object	Gets or sets enabled image transforms. The key corresponds to the transform name. If value is set to true, then correspondent transform is enabled. Otherwise this transform will not be used. Augmentation will be uniformly distributed among enabled transforms.

Project

Represents a project.

Name	Type	Description
created	string	Gets the date this project was created.
description	string	Gets or sets the description of the project.
drModeEnabled	boolean	Gets if the Disaster Recovery (DR) mode is on, indicating the project is temporarily read-only.
id	string	Gets the project id.
lastModified	string	Gets the date this project was last modified.
name	string	Gets or sets the name of the project.
settings	ProjectSettings	Gets or sets the project settings.
status	ProjectStatus	Gets the status of the project.
thumbnailUri	string	Gets the thumbnail url representing the image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.

ProjectSettings

Represents settings associated with a project.

Name	Type	Description
classificationType	Classifier	Gets or sets the classification type of the project.
detectionParameters	string	Detection parameters in use, if any.
domainId	string	Gets or sets the id of the Domain to use with this project.
imageProcessingSettings	ImageProcessingSettings	Gets or sets image preprocessing settings.
targetExportPlatforms	TargetExportPlatforms[]	A list of ExportPlatform that the trained model should be able to support.
useNegativeSet	boolean	Indicates if negative set is being used.

ProjectStatus

Gets the status of the project.

Name	Type	Description
Failed	string
Importing	string
Succeeded	string

TargetExportPlatforms

A list of ExportPlatform that the trained model should be able to support.

Name	Type	Description
CoreML	string
DockerFile	string
ONNX	string
TensorFlow	string
VAIDK	string