About the Legacy SDK
This archive contains documentation for thefish_audio_sdk module using the Session-based API. While this API still functions, it is no longer actively maintained and lacks the modern features available in the new SDK.
What’s Different in the New SDK
The new Python SDK (fishaudio module) offers:
- Modern client-based architecture - More intuitive and consistent with modern Python libraries
- Full async support - Native asyncio integration for better performance
- Better type safety - Comprehensive type hints and better IDE support
- Improved error handling - More detailed error messages and exception hierarchy
- Enhanced utilities - Built-in audio playback, streaming, and file management
- Active maintenance - Regular updates and new features
Migration Path
We strongly recommend migrating to the new SDK. The migration guide provides:- Side-by-side code comparisons
- Complete list of breaking changes
- Common migration patterns
- Troubleshooting tips
Migration
Migration Guide
Complete guide to upgrading from the legacy SDK to the new client-based API
Legacy Documentation Pages
Installation
How to install the legacy SDK
Authentication
Session initialization and API keys
Text-to-Speech
TTS with the Session-based API
Voice Cloning
Reference audio and voice models
Speech-to-Text
ASR transcription with legacy API
WebSocket Streaming
Real-time streaming with WebSocketSession