# 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

- [Coding Assistant Quickstart](https://docs.fish.audio/developer-guide/resources/agent-quickstart.md): Minimal-noise entry point for AI coding assistants with retrieval order, canonical URLs, and task routing.
- [Quick Start](https://docs.fish.audio/developer-guide/getting-started/quickstart.md): Generate your first AI voice with Fish Audio in under 5 minutes.
- [AI Coding Assistants](https://docs.fish.audio/developer-guide/resources/coding-agents.md): Install the Fish Audio skill so your coding agent writes correct SDK and API code.

## API Specs

- [OpenAPI](https://docs.fish.audio/api-reference/openapi.json): REST API schema for text-to-speech, speech-to-text, wallet, and voice model endpoints.
- [AsyncAPI](https://docs.fish.audio/api-reference/asyncapi.yml): WebSocket schema for real-time text-to-speech streaming.

## Core REST API

- [API Introduction](https://docs.fish.audio/api-reference/introduction.md): How to use the Fish Audio API.
- [Text to Speech Endpoint](https://docs.fish.audio/api-reference/endpoint/openapi-v1/text-to-speech.md): Convert text to speech.
- [Speech to Text Endpoint](https://docs.fish.audio/api-reference/endpoint/openapi-v1/speech-to-text.md): Transcribe audio to text.
- [Voice Design Endpoint](https://docs.fish.audio/api-reference/endpoint/openapi-v1/voice-design.md): Generate candidate voices from a prompt.
- [List Models](https://docs.fish.audio/api-reference/endpoint/model/list-models.md): Get a list of all models.
- [Create Model](https://docs.fish.audio/api-reference/endpoint/model/create-model.md): Create a new voice model.
- [Get Model](https://docs.fish.audio/api-reference/endpoint/model/get-model.md): Get details of a specific model.
- [Update Model](https://docs.fish.audio/api-reference/endpoint/model/update-model.md): Update an existing model.
- [Delete Model](https://docs.fish.audio/api-reference/endpoint/model/delete-model.md): Delete an existing model.
- [WebSocket TTS Streaming](https://docs.fish.audio/api-reference/endpoint/websocket/tts-live.md): Real-time text-to-speech streaming via WebSocket.

## SDKs

- [Python SDK Overview](https://docs.fish.audio/developer-guide/sdk-guide/python/overview.md): Official Python SDK overview and setup.
- [Python Authentication](https://docs.fish.audio/developer-guide/sdk-guide/python/authentication.md): Configure API authentication for the Fish Audio Python SDK.
- [Python Text-to-Speech](https://docs.fish.audio/developer-guide/sdk-guide/python/text-to-speech.md): Generate natural-sounding speech with the Fish Audio Python SDK.
- [Python Voice Cloning](https://docs.fish.audio/developer-guide/sdk-guide/python/voice-cloning.md): Clone voices and create custom voice models with the Fish Audio Python SDK.
- [Python WebSocket Streaming](https://docs.fish.audio/developer-guide/sdk-guide/python/websocket.md): Stream text-to-speech in real-time with WebSocket connections.
- [JavaScript Installation](https://docs.fish.audio/developer-guide/sdk-guide/javascript/installation.md): Install and set up the Fish Audio JavaScript SDK.
- [JavaScript Authentication](https://docs.fish.audio/developer-guide/sdk-guide/javascript/authentication.md): Manage API keys and client setup in the Fish Audio JavaScript SDK.
- [JavaScript Text-to-Speech](https://docs.fish.audio/developer-guide/sdk-guide/javascript/text-to-speech.md): Convert text to natural speech with Fish Audio JavaScript SDK.
- [JavaScript Voice Cloning](https://docs.fish.audio/developer-guide/sdk-guide/javascript/voice-cloning.md): Clone voices using reference audio with Fish Audio JavaScript SDK.
- [JavaScript WebSocket](https://docs.fish.audio/developer-guide/sdk-guide/javascript/websocket.md): Real-time streaming with Fish Audio JavaScript SDK.

## Product Guides

- [Text to Speech Guide](https://docs.fish.audio/developer-guide/core-features/text-to-speech.md): Convert text to natural-sounding speech with Fish Audio.
- [Speech to Text Guide](https://docs.fish.audio/developer-guide/core-features/speech-to-text.md): Convert audio recordings into accurate text transcriptions.
- [Voice Design Guide](https://docs.fish.audio/features/voice-design.md): Generate candidate voices from natural-language prompts.
- [Creating Voice Models](https://docs.fish.audio/developer-guide/core-features/creating-models.md): Learn how to create custom voice models with Fish Audio.
- [Emotion Control](https://docs.fish.audio/developer-guide/core-features/emotions.md): Add natural emotions and expressions to your AI-generated speech.
- [Fine-grained Control](https://docs.fish.audio/developer-guide/core-features/fine-grained-control.md): Advanced control over speech generation.
- [English Phoneme Control](https://docs.fish.audio/developer-guide/core-features/fine-grained-control/english.md): Control English pronunciation with CMU Arpabet.
- [Chinese Phoneme Control](https://docs.fish.audio/developer-guide/core-features/fine-grained-control/chinese.md): Control Chinese pronunciation with tone-number pinyin.
- [Japanese Phoneme Control](https://docs.fish.audio/developer-guide/core-features/fine-grained-control/japanese.md): Control Japanese pronunciation with romaji phonemes and pitch accent markers.
- [Voice Cloning Best Practices](https://docs.fish.audio/developer-guide/best-practices/voice-cloning.md): Improve voice cloning quality and consistency.
- [Real-time Voice Streaming](https://docs.fish.audio/developer-guide/best-practices/real-time-streaming.md): Stream voice generation in real time for interactive applications.

## Voice Agents

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

## Operational Docs

- [Models Overview](https://docs.fish.audio/developer-guide/models-pricing/models-overview.md): Explore Fish Audio's voice generation models and their capabilities.
- [Choosing a Model](https://docs.fish.audio/developer-guide/models-pricing/choosing-a-model.md): Select the right Fish Audio model for your use case and requirements.
- [Pricing And Rate Limits](https://docs.fish.audio/developer-guide/models-pricing/pricing-and-rate-limits.md): Understand pricing, usage costs, and API rate limits.
- [Model Deprecations](https://docs.fish.audio/developer-guide/models-pricing/deprecations.md): Track deprecated models and migration timelines.
- [Migration Guide](https://docs.fish.audio/developer-guide/resources/migration.md): Switch from ElevenLabs, OpenAI, or other TTS providers to Fish Audio.
- [Changelog](https://docs.fish.audio/developer-guide/getting-started/changelog.md): Complete release history and version updates for Fish Audio products.