Azure AI Speech Projects API
The Projects API from Azure AI Speech — 2 operation(s) for projects.
The Projects API from Azure AI Speech — 2 operation(s) for projects.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/azure-ai-speech:azure-ai-speech-projects-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Custom voice Projects API
version: '2026-01-01'
description: Custom voice API to create and deploy your voice.
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
security:
- ApiKeyAuth: []
- OAuth2Auth:
- https://cognitiveservices.azure.com/.default
tags:
- name: Projects
paths:
/projects:
get:
operationId: Projects_List
description: Gets a list of projects for the authenticated Speech service resource.
parameters:
- $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
- $ref: '#/components/parameters/CustomListQueryParameters.skip'
- $ref: '#/components/parameters/CustomListQueryParameters.maxpagesize'
- $ref: '#/components/parameters/CustomListQueryParameters.filter'
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/PagedProject'
default:
description: An unexpected error response.
headers:
x-ms-error-code:
description: String error code indicating what went wrong.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
x-ms-examples:
Get all projects:
$ref: ./examples/get_projects.json
x-ms-pageable:
nextLinkName: nextLink
tags:
- Projects
summary: Projects list
x-summary-source: derived
/projects/{id}:
get:
operationId: Projects_Get
description: Gets the project identified by the given ID.
parameters:
- $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: id
in: path
description: Resource id
required: true
schema:
type: string
maxLength: 64
minLength: 3
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
default:
description: An unexpected error response.
headers:
x-ms-error-code:
description: String error code indicating what went wrong.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
x-ms-examples:
Get a project:
$ref: ./examples/get_project.json
tags:
- Projects
summary: Projects get
x-summary-source: derived
put:
operationId: Projects_Create
description: Creates a new project.
parameters:
- $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: id
in: path
description: The ID of the resource.
required: true
schema:
type: string
maxLength: 64
minLength: 3
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
responses:
'201':
description: The request has succeeded and a new resource has been created as a result.
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
default:
description: An unexpected error response.
headers:
x-ms-error-code:
description: String error code indicating what went wrong.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
x-ms-examples:
Create a project:
$ref: ./examples/create_project.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
description: project definition
required: true
tags:
- Projects
summary: Projects create
x-summary-source: derived
delete:
operationId: Projects_Delete
description: 'Deletes the project identified by the given ID. All data (like consent,
training set) in this project will be deleted automatically.'
parameters:
- $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: id
in: path
description: The ID of the resource.
required: true
schema:
type: string
maxLength: 64
minLength: 3
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
- name: forceDelete
in: query
description: 'Set this to true if you want to delete a project with model and endpoint.
Otherwise, the delete operation will fail.'
required: false
schema:
type: boolean
responses:
'204':
description: 'There is no content to send for this request, but the headers may be useful. '
default:
description: An unexpected error response.
headers:
x-ms-error-code:
description: String error code indicating what went wrong.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
x-ms-examples:
Delete a project:
$ref: ./examples/delete_project.json
tags:
- Projects
summary: Projects delete
x-summary-source: derived
components:
schemas:
resourceId:
type: string
description: Resource ID
minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
Azure.Core.Foundations.InnerError:
type: object
description: An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
properties:
code:
type: string
description: One of a server-defined set of error codes.
innererror:
$ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
description: Inner error.
PagedProject:
type: object
description: Paged collection of Project items
properties:
value:
type: array
description: The Project items on this page
items:
$ref: '#/components/schemas/Project'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
ProjectKind:
type: string
description: Project kind
enum:
- ProfessionalVoice
- PersonalVoice
x-ms-enum:
name: ProjectKind
modelAsString: true
values:
- name: ProfessionalVoice
value: ProfessionalVoice
description: ProfessionalVoice
- name: PersonalVoice
value: PersonalVoice
description: PersonalVoice
Project:
type: object
description: 'Project object. Consents, training sets, models, and endpoints are organized in
a project.'
properties:
id:
$ref: '#/components/schemas/resourceId'
description: Resource id
readOnly: true
displayName:
type: string
description: Project name
minLength: 1
description:
type: string
description: Project description
kind:
$ref: '#/components/schemas/ProjectKind'
description: Project kind
locale:
type: string
description: 'The locale of this project. 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.'
createdDateTime:
type: string
format: date-time
description: '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).'
readOnly: true
required:
- id
- kind
Azure.Core.Foundations.Error:
type: object
description: The error object.
properties:
code:
type: string
description: One of a server-defined set of error codes.
message:
type: string
description: A human-readable representation of the error.
target:
type: string
description: The target of the error.
details:
type: array
description: An array of details about specific errors that led to this reported error.
items:
$ref: '#/components/schemas/Azure.Core.Foundations.Error'
innererror:
$ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
description: An object containing more specific information than the current object about the error.
required:
- code
- message
Azure.Core.Foundations.ErrorResponse:
type: object
description: A response containing error details.
properties:
error:
$ref: '#/components/schemas/Azure.Core.Foundations.Error'
description: The error object.
required:
- error
parameters:
CustomListQueryParameters.maxpagesize:
name: maxpagesize
in: query
description: The maximum number of items to include in a single response.
required: false
x-ms-parameter-location: method
schema:
type: integer
format: int32
default: 100
CustomListQueryParameters.filter:
name: filter
in: query
description: 'Filter condition.
- **Supported properties:** projectId, createdDateTime, locale, kind
- **Operators:**
- eq, ne are supported for all properties.
- gt, ge, lt, le are supported for createdDateTime.
- **Example:**
- ```filter=projectId eq ''Jessica''``` (filter by project ID)
- ```filter=kind eq ''ProfessionalVoice''``` (filter project by kind)
- ```filter=locale eq ''en-US''``` (filter training set and model by locale)
- ```filter=createdDateTime gt 2022-12-30T23:59:59.99Z``` (filter resource
created time after 2023-11-01)'
required: false
x-ms-parameter-location: method
schema:
type: string
CustomListQueryParameters.skip:
name: skip
in: query
description: The number of result items to skip.
required: false
x-ms-parameter-location: method
schema:
type: integer
format: int32
default: 0
Azure.Core.Foundations.ApiVersionParameter:
name: api-version
in: query
description: The API version to use for this operation.
required: true
x-ms-parameter-location: method
x-ms-client-name: apiVersion
schema:
type: string
minLength: 1
securitySchemes:
ApiKeyAuth:
type: apiKey
name: Ocp-Apim-Subscription-Key
in: header
OAuth2Auth:
type: oauth2
flows:
implicit:
scopes:
https://cognitiveservices.azure.com/.default: ''
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
x-ms-parameterized-host:
hostTemplate: '{endpoint}/customvoice'
useSchemePrefix: false
parameters:
- name: endpoint
in: path
description: 'Supported Cognitive Services endpoints (protocol and hostname, for example:
https://eastus.api.cognitive.microsoft.com).'
required: true
type: string
format: uri
x-ms-skip-url-encoding: true