2026-10-03
▼ ▲ aiplatform.projects.locations.voices.create
Parameter Order : parent
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a custom voice from a natural-language prompt (`VOICE_TYPE_PROMPTED`) or from reference and consent audio recordings (`VOICE_TYPE_REPLICATED`).
Parameters :
parent
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent resource where this voice will be created. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/voices:create
Path : v1beta1/{+parent}/voices:create
▼ ▲ aiplatform.projects.locations.voices.get
Description : Gets a custom stored voice (`store = true`) by resource name. Prebuilt catalog voices (`VOICE_TYPE_PREBUILT`) cannot be retrieved via `GetVoice`; use `ListVoices` instead.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/voices/[^/]+$
Description : Required. The resource name of the custom stored voice to retrieve (for example, `voices/voice_abc123def456`).
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/voices/{voicesId}:get
HTTP Method : GET
Path : v1beta1/{+name}:get
▼ ▲ aiplatform.projects.locations.voices.delete
HTTP Method : DELETE
Path : v1beta1/{+name}:delete
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/voices/[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The resource name of the custom stored voice to delete (for example, `voices/voice_abc123def456`).
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/voices/{voicesId}:delete
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a custom stored voice (`store = true`) by resource name. Prebuilt catalog voices (`"prebuilt"`) cannot be deleted.
▼ ▲ aiplatform.projects.locations.voices.list
Parameters :
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. The maximum number of voices to return per page. The service may return fewer than this value. If unspecified, at most 50 voices are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
pitch
Type : string
Repeated : Yes
Location : query
Description : Optional. Filter by vocal pitch. Accepts `"low"`, `"medium"`, `"high"` (case-insensitive). If multiple values are specified, matches voices with any of the specified pitches (OR).
pageToken
Description : A page token, received from a previous `ListVoices` call. Provide this to retrieve the subsequent page. When paginating, all filter query parameters (`language_code`, `region_code`, `accent`, `persona`, `context`, `gender`, `pitch`, `type`, and `search`) must match the call that returned this token; otherwise the request fails with `INVALID_ARGUMENT`. `page_size` may change between pages.
Type : string
Location : query
languageCode
Description : Optional. Filter by BCP-47 language code (e.g. "en-US"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified language codes (OR).
Type : string
Location : query
Repeated : Yes
context
Location : query
Description : Optional. Filter by intended context or domain (e.g. "News, Commercial"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified contexts (OR).
Type : string
Repeated : Yes
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Description : Required. The parent that owns this collection of voices. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API.
accent
Description : Optional. Filter by accent description (e.g. "American", "British"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified accents (OR).
Repeated : Yes
Location : query
Type : string
search
Description : Optional. Free-text substring search query matched case-insensitively against both `display_name` and `description`. Maximum 2048 bytes.
Location : query
Type : string
gender
Description : Optional. Filter by gender presentation (e.g. "female", "male", "neutral"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified genders (OR).
Type : string
Location : query
Repeated : Yes
persona
Description : Optional. Filter by vocal persona (e.g. "Warm, Friendly"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified personas (OR).
Location : query
Type : string
Repeated : Yes
regionCode
Location : query
Type : string
Description : Optional. Filter by ISO 3166-1 alpha-2 or UN M.49 region code (e.g. "US", "001"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified region codes (OR).
Repeated : Yes
type
Repeated : Yes
Type : string
Description : Optional. Filter by voice type. Accepts `"prebuilt"`, `"replicated"`, `"prompted"` (case-insensitive). If multiple values are specified, matches voices with any of the specified types (OR).
Location : query
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/voices:list
Description : Lists custom stored voices owned by the caller as well as prebuilt system voices from Google's voice catalog.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+parent}/voices:list
Parameter Order : parent
▼ ▲ aiplatform.projects.updateCacheConfig
Parameters :
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Optional. The list of fields of `cache_config` to update. Supported paths are `disable_cache`, `retention_config` (and its subfields such as `retention_config.retention_type`), and the special value `*`; any other path returns `INVALID_ARGUMENT`. Fields not covered by the mask keep their stored value. If the mask is omitted, it is treated as an implied mask covering the fields populated in `cache_config`, so updating one field never clears another. `retention_config` is covered only when the request carries it. `disable_cache` is always covered: it is a bare `bool`, so the server cannot tell a request that omits it from one that sets it to `false`. `*` requests full replacement of the resource: every settable field is written from the request, clearing `retention_config` when the request omits it. It cannot be combined with other paths. Prefer naming fields explicitly -- a caller that sends `*` without knowing about a field added to `CacheConfig` later would silently reset that field.
▼ ▲ aiplatform.projects.locations.agents.create
▼ ▲ aiplatform.projects.locations.agents.list
▼ ▲ aiplatform.projects.locations.agents.get
▼ ▲ aiplatform.projects.locations.agents.patch
▼ ▲ aiplatform.projects.locations.agents.delete