Skip to main content

List Available Voices

The listing returns every voice visible to you, page by page. language filters by the voices’ BCP-47 language tags, case-insensitively: "de" matches every German accent (de-DE, de-AT, de-CH), "de-AT" only Austrian German. getTotal() and the pages count the filtered set. The includePublic argument is accepted for compatibility and has no effect. Voice IDs are numeric (int) throughout the Java SDK. To use a voice handle, resolve it with GET /v1/voices/{handle} and use the returned id.

Get a Specific Voice

get() returns the catalog shape, so isPublic() is always false and getReferences() is empty here; use listReferences(...) for references.

Create a Voice

The current Java SDK serializes its language argument under the legacy language key, while the API accepts supported_languages. Voice creation still succeeds, but that argument does not set the returned voice’s language list; use the REST endpoint when you need to set supported_languages.
Update, delete, reference, and publish calls need a voice you own, so the examples below use myVoiceId from this step.

Update a Voice

The map can carry API field names, but is_public is not accepted by the current update endpoint. To request publication, call publish() below.

Delete a Voice

Manage Reference Audio

The current Java VoiceReference model maps id and reference_text correctly, but its legacy filename property is not populated by the current API response. See Types for the other legacy voice model fields.

Publish a Voice

Request publication of your voice. This sets pending_verification: true on the voice; an admin review decides whether it becomes public. The call does not change is_public, and the Java VoiceDetail does not expose pending_verification, so check the state with the REST endpoint.

Next steps

  • Dictionaries: per-project pronunciation and replacement lists
  • Types: Voice, VoiceDetail, and VoiceReference
  • Voice API reference: generate a sample or upload an avatar with the REST response shapes
Last modified on September 23, 2026