Consents - Post

Service:

Cognitive Services - Custom Voice

API Version:

2023-12-01-preview

Creates a new voice talent consent with the provided audio file.

POST {endpoint}/customvoice/consents/{id}?api-version=2023-12-01-preview

URI Parameters

Name	In	Required	Type	Description
audiodata	formData	True	file	An audio file containing the audio data.
companyName	formData	True	string	The name of company.
locale	formData	True	string	The locale of this consent. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	formData	True	string	The project ID. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
voiceTalentName	formData	True	string	The name of voice talent.
description	formData		string	Optional description of this consent.
displayName	formData		string	The display name of this consent.
properties	formData		string	properties.
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

Media Types: "multipart/form-data"

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	Provide your Speech resource key here.
Operation-Id		string	ID of the status monitor for the operation. If the Operation-Id header matches an existing operation and the request is not identical to the prior request, it will fail with a 400 Bad Request. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Responses

Name	Type	Description
201 Created	Consent	Created Headers Operation-Id: string Operation-Location: string
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 consent

Sample Request

HTTP

POST {endpoint}/customvoice/consents/Jessica?api-version=2023-12-01-preview

Sample Response

Status code:

201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/070f7986-ef17-41d0-ba2b-907f0f28e314?api-version=2023-12-01-preview
Operation-Id: 070f7986-ef17-41d0-ba2b-907f0f28e314

Response Body

{
  "id": "Jessica",
  "description": "Consent for Jessica voice",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith",
  "companyName": "Contoso",
  "locale": "en-US",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definitions

Name	Description
Consent	Consent object
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).
Status	Status of a resource.

Consent

Consent object

Name	Type	Description
audioUrl	string	The public accessible URL of the consent audio file. It's recommended to be an Azure blob URL with SAS. This property is only available in request.
companyName	string	Company name. Must match the company name in the consent audio file.
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	Description of consent.
displayName	string	Name of consent.
id	string	Resource id
lastActionDateTime	string	The timestamp when the current status was entered. 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).
locale	string	The locale of this consent. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Resource id
status	Status	Status of a resource.
voiceTalentName	string	Voice talent name. Must match the voice talent name in the consent audio file.

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.

Status

Status of a resource.

Name	Type	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string