feat: default output format to mp3 - #8
Merged
Merged
Conversation
Without an explicit format the API's server default applies — currently wav (~9x larger than mp3 for the same speech) and documented as subject to change. Peer providers (ElevenLabs, OpenAI) default to mp3. The unknown-format warning path now also falls back to mp3 instead of the server default.
The developer platform brands as SpeechifyAI (one word) — docs.speechify.ai title and product names — distinct from the Speechify consumer app. Code identifiers, npm scope, and SPEECHIFY_API_KEY are unchanged contracts.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
With no
outputFormat, the provider previously sent no format and inherited the API's server default — wav, which is ~9x larger than mp3 for the same speech (390 KB vs 41 KB in the E2E run) and documented in the spec as subject to change ("we recommend always passing the specific param you expect"). Peer speech providers (ElevenLabs, OpenAI) default to mp3.audio_format: "mp3"outputFormat(warned) → falls back to mp3 instead of the server defaultLive-verified: defaults now return
audio/mpeg(41 KB) with zero warnings. 20/20 tests.