Class Voices

constructor

• new Voices(options?: SDKOptions): Voices

  Parameters

  • options: SDKOptions = {}

  Returns Voices

Readonly_baseURL

Readonly_hooks

Readonly_httpClient

Optional Readonly_logger

Readonly_options

_createRequest

• _createRequest(
      context: HookContext,
      conf: RequestConfig,
      options?: RequestOptions,
  ): Result<Request, UnexpectedClientError | InvalidRequestError>

  Parameters

  • context: HookContext
  • conf: RequestConfig
  • Optionaloptions: RequestOptions

  Returns Result<Request, UnexpectedClientError | InvalidRequestError>

_do

• _do(
      request: Request,
      options: {
          context: HookContext;
          isErrorStatusCode: (statusCode: number) => boolean;
          retryCodes: string[];
          retryConfig: RetryConfig;
      },
  ): Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

  Parameters

  • request: Request
  • options: {
        context: HookContext;
        isErrorStatusCode: (statusCode: number) => boolean;
        retryCodes: string[];
        retryConfig: RetryConfig;
    }

  Returns Promise<
      Result<
          Response,
          | UnexpectedClientError
          | RequestAbortedError
          | RequestTimeoutError
          | ConnectionError,
      >,
  >

create

• create(
      body: CreateVoiceRequest,
      api_version?: string,
      options?: RequestOptions,
  ): APIPromise<VoiceOutput>

  Creates a custom voice from a natural-language prompt (VOICE_TYPE_PROMPTED) or from reference and consent audio recordings (VOICE_TYPE_REPLICATED).

  Parameters

  • body: CreateVoiceRequest
  • Optionalapi_version: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<VoiceOutput>

delete

• delete(
      id: string,
      params?: DeleteVoiceParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<DeleteVoiceResponse>

  Deletes a custom stored voice (store = true) by resource name. Prebuilt catalog voices (VOICE_TYPE_PREBUILT) cannot be deleted.

  Parameters

  • id: string
  • Optionalparams: DeleteVoiceParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<DeleteVoiceResponse>

get

• get(
      id: string,
      params?: GetVoiceParams,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<VoiceOutput>

  Gets a custom stored voice (store = true) by resource name. Prebuilt catalog voices (VOICE_TYPE_PREBUILT) cannot be retrieved via GetVoice; use ListVoices instead.

  Parameters

  • id: string
  • Optionalparams: GetVoiceParams
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<VoiceOutput>

list

• list(
      params?: ListVoicesRequest,
      options?: Omit<RequestOptions, "extra_body">,
  ): APIPromise<ListVoicesResponse>

  Lists custom stored voices owned by the caller (ordered newest first) followed by prebuilt system voices from Google's voice catalog.

  Parameters

  • Optionalparams: ListVoicesRequest
  • Optionaloptions: Omit<RequestOptions, "extra_body">

  Returns APIPromise<ListVoicesResponse>