Projects - Create

Service:

Cognitive Services - Custom Voice

API Version:

2023-12-01-preview

Creates a new project.

PUT {endpoint}/customvoice/projects/{id}?api-version=2023-12-01-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	The ID of the resource. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version	query	True	string	The API version to use for this operation.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	Provide your Speech resource key here.

Request Body

Name	Required	Type	Description
kind	True	ProjectKind	Project kind
description		string	Project description
displayName		string	Project name
id		string	Resource id

Responses

Name	Type	Description
201 Created	Project	Created
Other Status Codes	ErrorResponse	An error occurred.

Security

Ocp-Apim-Subscription-Key

Provide your Speech resource key here.

Type: apiKey
In: header

Examples

Create a project

Sample Request

HTTP

PUT {endpoint}/customvoice/projects/Jessica?api-version=2023-12-01-preview


{
  "description": "Project for Jessica Voice",
  "kind": "ProfessionalVoice"
}

Sample Response

Status code:

201

{
  "id": "Jessica",
  "description": "Project for Jessica Voice",
  "kind": "ProfessionalVoice",
  "createdDateTime": "2023-04-01T05:30:00.000Z"
}

Definitions

Name	Description
Error	Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details.
ErrorCode	Top-level error code
ErrorResponse	Error response follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).
Project	Project object. Consents, training sets, models, and endpoints are organized in a project.
ProjectKind	Project kind

Error

Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details.

Name	Type	Description
code	ErrorCode	Top-level error code
details	Error[]	Additional supportive details regarding the error and/or expected policies.
innererror	InnerError	Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).
message	string	Top-level error message.
target	string	The source of the error. For example it would be "model" or "model id" in case of invalid model.

ErrorCode

Top-level error code

Name	Type	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Error response follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
error	Error	Top-level error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains an top-level error with error code, message, details, target and an inner error with more descriptive details.

InnerError

Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).

Name	Type	Description
code	string	Detailed error code to help diagnostic.
innererror	InnerError	Inner error follows Microsoft Azure REST API Guidelines which is available at https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. This contains required properties error code, message and optional properties target, inner error(this can be nested).
message	string	Detailed error message.
target	string	The source of the error. For example it would be "model" or "model id" in case of invalid model.

Project

Project object. Consents, training sets, models, and endpoints are organized in a project.

Name	Type	Description
createdDateTime	string	The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Project description
displayName	string	Project name
id	string	Resource id
kind	ProjectKind	Project kind

ProjectKind

Project kind

Name	Type	Description
PersonalVoice	string
ProfessionalVoice	string