Edit

Share via

Create a project for personal voice (preview)

  • Article

Note

Personal voice for text to speech is currently in public preview. This preview is provided without a service-level agreement, and is not recommended for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews.

Personal voice projects contain the user consent statement and the personal voice ID. You can only create a personal voice project using the custom voice API. You can't create a personal voice project in the Speech Studio.

Create a project

To create a personal voice project, use the Projects_Create operation of the custom voice API. Construct the request body according to the following instructions:

  • Set the required kind property to PersonalVoice. The kind can't be changed later.
  • Optionally, set the description property for the project description. The project description can be changed later.

Make an HTTP PUT request using the URI as shown in the following Projects_Create example.

  • Replace YourResourceKey with your Speech resource key.
  • Replace YourResourceRegion with your Speech resource region.
  • Replace ProjectId with a project ID of your choice. The case sensitive ID must be unique within your Speech resource. The ID will be used in the project's URI and can't be changed later.
curl -v -X PUT -H "Ocp-Apim-Subscription-Key: YourResourceKey" -H "Content-Type: application/json" -d '{
  "description": "Project description",
  "kind": "PersonalVoice"
} '  "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/projects/ProjectId?api-version=2023-12-01-preview"

You should receive a response body in the following format:

{
  "id": "ProjectId",
  "description": "Project description",
  "kind": "PersonalVoice",
  "createdDateTime": "2023-04-01T05:30:00.000Z"
}

You use the project id in subsequent API requests to add user consent and get a speaker profile ID.

Next steps

Add user consent to the personal voice project.