LICENSE Documentation

1. Project Overview & Quickstart (fishaudio/LICENSE) Copy Chapter

LICENSE

Open-source repository fishaudio/LICENSE

Repository Details Copy Section

• Repository: fishaudio/LICENSE
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (fishaudio/docs) Copy Chapter

Fish Audio

Canonical documentation index for Fish Audio APIs, SDKs, models, voice cloning, real-time streaming, and self-hosting. This custom index prioritizes the lowest-noise, highest-value entry points for AI agents.

Start Here Copy Chapter

• Coding Assistant Quickstart: Minimal-noise entry point for AI coding assistants with retrieval order, canonical URLs, and task routing.
• Quick Start: Generate your first AI voice with Fish Audio in under 5 minutes.
• AI Coding Assistants: Install the Fish Audio skill so your coding agent writes correct SDK and API code.

API Specs Copy Chapter

• OpenAPI: REST API schema for text-to-speech, speech-to-text, wallet, and voice model endpoints.
• AsyncAPI: WebSocket schema for real-time text-to-speech streaming.

Core REST API Copy Chapter

• API Introduction: How to use the Fish Audio API.
• Text to Speech Endpoint: Convert text to speech.
• Speech to Text Endpoint: Transcribe audio to text.
• Voice Design Endpoint: Generate candidate voices from a prompt.
• List Models: Get a list of all models.
• Create Model: Create a new voice model.
• Get Model: Get details of a specific model.
• Update Model: Update an existing model.
• Delete Model: Delete an existing model.
• WebSocket TTS Streaming: Real-time text-to-speech streaming via WebSocket.

SDKs Copy Chapter

• Python SDK Overview: Official Python SDK overview and setup.
• Python Authentication: Configure API authentication for the Fish Audio Python SDK.
• Python Text-to-Speech: Generate natural-sounding speech with the Fish Audio Python SDK.
• Python Voice Cloning: Clone voices and create custom voice models with the Fish Audio Python SDK.
• Python WebSocket Streaming: Stream text-to-speech in real-time with WebSocket connections.
• JavaScript Installation: Install and set up the Fish Audio JavaScript SDK.
• JavaScript Authentication: Manage API keys and client setup in the Fish Audio JavaScript SDK.
• JavaScript Text-to-Speech: Convert text to natural speech with Fish Audio JavaScript SDK.
• JavaScript Voice Cloning: Clone voices using reference audio with Fish Audio JavaScript SDK.
• JavaScript WebSocket: Real-time streaming with Fish Audio JavaScript SDK.

Product Guides Copy Chapter

• Text to Speech Guide: Convert text to natural-sounding speech with Fish Audio.
• Speech to Text Guide: Convert audio recordings into accurate text transcriptions.
• Voice Design Guide: Generate candidate voices from natural-language prompts.
• Creating Voice Models: Learn how to create custom voice models with Fish Audio.
• Emotion Control: Add natural emotions and expressions to your AI-generated speech.
• Fine-grained Control: Advanced control over speech generation.
• English Phoneme Control: Control English pronunciation with CMU Arpabet.
• Chinese Phoneme Control: Control Chinese pronunciation with tone-number pinyin.
• Japanese Phoneme Control: Control Japanese pronunciation with romaji phonemes and pitch accent markers.
• Voice Cloning Best Practices: Improve voice cloning quality and consistency.
• Real-time Voice Streaming: Stream voice generation in real time for interactive applications.

Voice Agents Copy Chapter

• Agents Overview: The Fish Audio voice-agent platform — build agents in the console, integrate via REST API and web SDK.
• Agents Quickstart: Create, test, and publish your first voice agent via the dashboard or the API.
• Agent Concepts: Workspaces, agents, draft and published versions, and sessions.
• Agent Configuration: System prompt, first message modes, and draft autosave.
• Voice & Language: Choose the agent's voice profile and speaking language.
• Time & Timezone: Agents know the current date and time by default; timezone resolution and opt-out.
• Knowledge Base: Attach documents so the agent can answer from your content.
• Tools Overview: Webhook, client, and system tools for voice agents.
• Webhook Tools: Let the agent call your HTTP endpoints, with templating and testing.
• Client Tools: Tools your app executes in the browser through the SDK.
• System Tools: Built-in capabilities like hanging up the call.
• Dynamic Variables: Personalize each session with template variables supplied at creation time.
• Custom LLM: Serve your agent's replies from your own OpenAI-compatible model endpoint.
• Versions & Publishing: Draft, publish, clone, and restore agent configurations.
• Deployment Overview: Pick a deployment channel — widget, public agents, authenticated sessions, or a phone number.
• Authentication & Session Tokens: Public agent IDs vs server-minted session tokens; POST /v1/agent/sessions.
• Public Agents: Credential-free browser access with an origin allowlist.
• Web SDK: @fishaudio/agent-client — events, modes, transcripts, audio controls, and errors.
• React SDK: React hooks and components for voice-agent UIs.
• Widget: Embed a complete voice and chat UI on any website with two lines of HTML — no build step.
• Wire Protocol: The realtime message protocol for non-SDK consumers.
• Phone Numbers: Manage phone numbers and bind them to agents.
• Inbound Calls: Answer phone calls with an agent and track caller attribution.
• Call Transfers: Let the agent hand a phone call to a human — cold carrier handoff or warm transfer with a private briefing.
• Preview Calls: Test your draft agent by voice inside the Builder.
• Agent Tests: Scripted next-reply tests scored by an LLM judge.
• Conversation History: Query sessions, transcripts, tool timelines, and recordings via the API.
• Post-call Analysis: Automatic summaries, data extraction, and success criteria.
• Agent Webhooks: call.ended and call.analyzed events with HMAC signature verification.

Operational Docs Copy Chapter

• Models Overview: Explore Fish Audio's voice generation models and their capabilities.
• Choosing a Model: Select the right Fish Audio model for your use case and requirements.
• Pricing And Rate Limits: Understand pricing, usage costs, and API rate limits.
• Model Deprecations: Track deprecated models and migration timelines.
• Migration Guide: Switch from ElevenLabs, OpenAI, or other TTS providers to Fish Audio.
• Changelog: Complete release history and version updates for Fish Audio products.