Fish Audio

Usage Instructions

Integrate Fish Audio into the workflow. Turn text into natural, expressive speech with library voices or your own clones, tuned for phone calls with 8 kHz to 44.1 kHz WAV or PCM output and low-latency modes. Browse and manage voice models, create a voice clone from consented recordings, transcribe recordings with speaker turns, and check your API credit.

Actions

Fish Audio Text to Speech

Generate speech with a Fish Audio library voice or your own voice clone, with control over model, format, sample rate, latency, speed, and volume

Input

ParameterTypeRequiredDescription
textstringYesThe text to convert to speech (e.g., "Hi, this is Maya from Acme. Is now a good time?")
apiKeystringYesFish Audio API key
referenceIdstringNoVoice model ID from the Fish Audio library or your own clones (e.g., "9a9cf47702da476aa4629e2506d4a857"). Omit to use the default voice
modelstringNoTTS model: s2.1-pro (default), s2-pro, s2.1-pro-free, drama-3, or s1 (deprecated)
formatstringNoOutput format: mp3 (default), wav, pcm (16-bit mono), or opus
sampleRatenumberNoSample rate in Hz. wav/pcm: 8000, 16000, 24000, 32000, 44100; mp3: 32000, 44100; opus: 48000. Defaults to 44100 (48000 for opus)
mp3BitratenumberNoMP3 bitrate in kbps: 64, 128 (default), or 192
latencystringNoLatency-quality trade-off: normal (best quality, default), balanced, or low
speednumberNoSpeaking rate multiplier from 0.5 to 2.0 (1.0 is normal)
volumenumberNoVolume adjustment in decibels (0 is unchanged, negative is quieter)
temperaturenumberNoExpressiveness from 0 to 1 (default 0.7). Lower is more consistent
topPnumberNoNucleus sampling diversity from 0 to 1 (default 0.7)
languagestringNoBCP-47 language tag of the text (e.g., "en", "es-MX"), used to spell out numbers and dates

Output

ParameterTypeDescription
audioUrlstringURL to the generated audio file
audioFilefileGenerated audio file (UserFile)
characterCountnumberNumber of characters processed
formatstringAudio format
providerstringTTS provider used
voicesarrayVoice models on this page
totalnumberTotal number of matching voices
hasMorebooleanWhether more pages are available
idstringVoice model ID, used as the TTS reference ID
titlestringVoice name
descriptionstringVoice description
typestringModel type
statestringTraining state (created, training, trained, failed)
trainModestringTraining mode
visibilitystringVisibility (public, unlist, private)
tagsarrayVoice tags
languagesarrayLanguages the voice speaks
coverImagestringCover image URL
samplesarraySample clips for previewing the voice
licensedbooleanWhether Fish Audio secured rights from the voice owner
likeCountnumberNumber of likes
taskCountnumberNumber of times the voice was used
authorIdstringAuthor user ID
authorNamestringAuthor nickname
createdAtstringCreation time (ISO 8601)
updatedAtstringLast update time (ISO 8601)
voiceIdstringID of the deleted voice model
deletedbooleanWhether the voice model was deleted
textstringFull transcript
durationnumberAudio length in seconds
segmentsarrayWord-level timestamps
speakerTurnsarrayTimed speaker turns
languageCodestringDetected ISO 639-1 language code
languagestringDetected language name
creditstringRemaining API credit balance
cumulativeTopUpstringTotal amount topped up
hasFreeCreditbooleanWhether the account has free credit

Fish Audio List Voices

List Fish Audio voice models: your own clones or the public voice library, filtered by name, tag, language, author, or licensing

Input

ParameterTypeRequiredDescription
apiKeystringYesFish Audio API key
selfbooleanNoReturn only voices owned by your workspace (default false, the public library)
titlestringNoFilter voices by title (e.g., "narrator")
tagsstringNoComma-separated tags to filter by (e.g., "female,calm")
languagestringNoComma-separated language codes to filter by (e.g., "en,es")
authorIdstringNoOnly public voices by this author ID (ignored when self is true)
licensedbooleanNoOnly voices Fish Audio licensed from the voice owner (ignored when self is true)
sortBystringNoSort order: score (default), task_count, or created_at
pageSizenumberNoVoices per page, 1 to 100 (default 10)
pageNumbernumberNoPage number, starting at 1 (default 1)

Output

ParameterTypeDescription
voicesarrayVoice models on this page
totalnumberTotal number of matching voices
hasMorebooleanWhether more pages are available

Fish Audio Get Voice

Get a Fish Audio voice model: its name, training state, languages, tags, and sample clips

Input

ParameterTypeRequiredDescription
apiKeystringYesFish Audio API key
voiceIdstringYesVoice model ID (e.g., "9a9cf47702da476aa4629e2506d4a857")

Output

ParameterTypeDescription
audioUrlstringURL to the generated audio file
audioFilefileGenerated audio file (UserFile)
characterCountnumberNumber of characters processed
formatstringAudio format
providerstringTTS provider used
voicesarrayVoice models on this page
totalnumberTotal number of matching voices
hasMorebooleanWhether more pages are available
idstringVoice model ID, used as the TTS reference ID
titlestringVoice name
descriptionstringVoice description
typestringModel type
statestringTraining state (created, training, trained, failed)
trainModestringTraining mode
visibilitystringVisibility (public, unlist, private)
tagsarrayVoice tags
languagesarrayLanguages the voice speaks
coverImagestringCover image URL
samplesarraySample clips for previewing the voice
licensedbooleanWhether Fish Audio secured rights from the voice owner
likeCountnumberNumber of likes
taskCountnumberNumber of times the voice was used
authorIdstringAuthor user ID
authorNamestringAuthor nickname
createdAtstringCreation time (ISO 8601)
updatedAtstringLast update time (ISO 8601)
voiceIdstringID of the deleted voice model
deletedbooleanWhether the voice model was deleted
textstringFull transcript
durationnumberAudio length in seconds
segmentsarrayWord-level timestamps
speakerTurnsarrayTimed speaker turns
languageCodestringDetected ISO 639-1 language code
languagestringDetected language name
creditstringRemaining API credit balance
cumulativeTopUpstringTotal amount topped up
hasFreeCreditbooleanWhether the account has free credit

Fish Audio Create Voice Clone

Create a Fish Audio voice clone from 1 to 20 audio samples (10 to 30 seconds of clear speech each works best). Only clone a voice with the consent of the person it belongs to: your own voice, or someone who gave written permission. The clone is ready to use as a TTS reference ID as soon as it is created

Input

ParameterTypeRequiredDescription
apiKeystringYesFish Audio API key
titlestringYesName for the voice clone (e.g., "Acme support voice")
audioFilesfile[]YesAudio samples of the voice (WAV, MP3, or FLAC), up to 20 files
consentConfirmedbooleanYesConfirms the person whose voice is in the samples consented to it being cloned. The clone is refused unless true
transcriptsarrayNoExact transcript of each sample, in the same order. Omit to let Fish Audio transcribe them
descriptionstringNoDescription of the voice
tagsarrayNoTags for the voice (e.g., ["brand", "support"])
visibilitystringNoprivate (default, only you) or unlist (anyone with the link)
enhanceAudioQualitybooleanNoClean up the samples before cloning (default true)

Output

ParameterTypeDescription
audioUrlstringURL to the generated audio file
audioFilefileGenerated audio file (UserFile)
characterCountnumberNumber of characters processed
formatstringAudio format
providerstringTTS provider used
voicesarrayVoice models on this page
totalnumberTotal number of matching voices
hasMorebooleanWhether more pages are available
idstringVoice model ID, used as the TTS reference ID
titlestringVoice name
descriptionstringVoice description
typestringModel type
statestringTraining state (created, training, trained, failed)
trainModestringTraining mode
visibilitystringVisibility (public, unlist, private)
tagsarrayVoice tags
languagesarrayLanguages the voice speaks
coverImagestringCover image URL
samplesarraySample clips for previewing the voice
licensedbooleanWhether Fish Audio secured rights from the voice owner
likeCountnumberNumber of likes
taskCountnumberNumber of times the voice was used
authorIdstringAuthor user ID
authorNamestringAuthor nickname
createdAtstringCreation time (ISO 8601)
updatedAtstringLast update time (ISO 8601)
voiceIdstringID of the deleted voice model
deletedbooleanWhether the voice model was deleted
textstringFull transcript
durationnumberAudio length in seconds
segmentsarrayWord-level timestamps
speakerTurnsarrayTimed speaker turns
languageCodestringDetected ISO 639-1 language code
languagestringDetected language name
creditstringRemaining API credit balance
cumulativeTopUpstringTotal amount topped up
hasFreeCreditbooleanWhether the account has free credit

Fish Audio Delete Voice

Permanently delete a voice model you own from Fish Audio

Input

ParameterTypeRequiredDescription
apiKeystringYesFish Audio API key
voiceIdstringYesID of the voice model to delete (e.g., "9a9cf47702da476aa4629e2506d4a857")

Output

ParameterTypeDescription
voiceIdstringID of the deleted voice model
deletedbooleanWhether the voice model was deleted

Fish Audio Speech to Text

Transcribe a recording of up to 60 minutes with Fish Audio, with optional word timestamps and speaker turns

Input

ParameterTypeRequiredDescription
apiKeystringYesFish Audio API key
audioFilefileYesRecording to transcribe (e.g., MP3, WAV, M4A)
modelstringNotranscribe-1-pro (default; long and multi-speaker recordings) or transcribe-1 (short recordings)
languagestringNoOptional lowercase ISO 639-1 language hint (e.g., "en", "ja")
includeTimestampsbooleanNoReturn word timestamps and, with transcribe-1-pro, speaker turns (default false; adds processing time)
numSpeakersnumberNoExpected number of speakers, a best-effort hint for transcribe-1-pro

Output

ParameterTypeDescription
textstringFull transcript. With transcribe-1-pro it includes <|speaker:N|> markers and bracketed cues such as [laughter]
durationnumberAudio length in seconds, including silence
segmentsarrayWord-level timestamps (empty unless timestamps were requested)
↳ textstringWord text
↳ startnumberStart time in seconds
↳ endnumberEnd time in seconds
speakerTurnsarrayTimed speaker turns (transcribe-1-pro with timestamps only)
↳ speakerstringSpeaker label, such as "speaker:0"
↳ textstringWhat the speaker said in this turn
↳ startnumberStart time in seconds
↳ endnumberEnd time in seconds
languageCodestringDetected ISO 639-1 language code
languagestringDetected language name

Fish Audio Get API Credit

Get the remaining Fish Audio API credit balance for the account behind the API key

Input

ParameterTypeRequiredDescription
apiKeystringYesFish Audio API key

Output

ParameterTypeDescription
creditstringRemaining API credit balance, as a decimal string
cumulativeTopUpstringTotal amount topped up, as a decimal string
hasFreeCreditbooleanWhether the account has free credit
updatedAtstringWhen the balance last changed (ISO 8601)