Type Alias VoiceInput

VoiceInput: {
    accent?: string;
    context?: string;
    description?: string;
    display_name?: string;
    gender?: string;
    language_code?: string;
    model?: string;
    persona?: string;
    pitch?: Pitch;
    prompted?: PromptedVoice;
    region_code?: string;
    replicated?: ReplicatedVoice;
    sample_audio?: AudioData;
    type: VoiceType;
}

A voice resource representing either a custom voice (created via

Type declaration

  • Optionalaccent?: string

    Optional. Regional accent descriptor (e.g. "American", "British").

  • Optionalcontext?: string

    Optional. Optimal usage context or domain (e.g. "Conversational",

    Remarks

    "Audiobook", "News").

  • Optionaldescription?: string

    Optional. Descriptive summary of vocal timbre, personality, and tone.

  • Optionaldisplay_name?: string

    Optional. User-provided display name for a stored voice (store = true),

    Remarks

    or the catalog name for a prebuilt voice.

  • Optionalgender?: string

    Optional. Perceived voice gender presentation (e.g. "female", "male",

    Remarks

    "neutral").

  • Optionallanguage_code?: string

    Optional. Primary BCP-47 language tag (e.g. "en-US", "fr-FR").

  • Optionalmodel?: string

    Optional. The model used to design or replicate the voice.

    Remarks

    If omitted in CreateVoice, defaults to the latest supported voice design model. Returned in CreateVoice, GetVoice, and ListVoices responses for custom voices ("prompted" and "replicated"); unset for "prebuilt" voices. Created voices can be synthesized across any supported TTS synthesis model.

  • Optionalpersona?: string

    Optional. Intended persona or character archetype (e.g. "Warm, Friendly",

    Remarks

    "Narrator").

  • Optionalpitch?: Pitch
  • Optionalprompted?: PromptedVoice

    Parameters for prompted voice generation.

    Remarks

    Required in CreateVoice when type is "prompted". Returned in CreateVoice, GetVoice, and ListVoices responses for prompted voices.

  • Optionalregion_code?: string

    Optional. ISO 3166-1 alpha-2 or UN M.49 geographic region code (e.g. "US",

    Remarks

    "GB", "001").

  • Optionalreplicated?: ReplicatedVoice

    Input only. Parameters for replicated voice generation.

    Remarks

    Required on input when type is "replicated". Not returned in responses.

  • Optionalsample_audio?: AudioData

    Audio payload used for voice creation.

  • type: VoiceType

Remarks

CreateVoice) or a prebuilt system voice (returned by ListVoices).

Settings