​

fishaudio.core.client_wrapper

​

BaseClientWrapper Objects

class BaseClientWrapper()

​

get_headers

def get_headers(
        additional_headers: Optional[dict[str, str]] = None) -> dict[str, str]

​

ClientWrapper Objects

class ClientWrapper(BaseClientWrapper)

​

request

def request(method: str,
            path: str,
            *,
            request_options: Optional[RequestOptions] = None,
            **kwargs: Any) -> httpx.Response

• method - HTTP method (GET, POST, etc.)
• path - API endpoint path
• request_options - Optional request-level overrides
• **kwargs - Additional arguments to pass to httpx.request

• APIError - On non-2xx responses

​

client

@property
def client() -> httpx.Client

​

close

def close() -> None

​

AsyncClientWrapper Objects

class AsyncClientWrapper(BaseClientWrapper)

​

request

async def request(method: str,
                  path: str,
                  *,
                  request_options: Optional[RequestOptions] = None,
                  **kwargs: Any) -> httpx.Response

• method - HTTP method (GET, POST, etc.)
• path - API endpoint path
• request_options - Optional request-level overrides
• **kwargs - Additional arguments to pass to httpx.request

• APIError - On non-2xx responses

​

client

@property
def client() -> httpx.AsyncClient

​

close

async def close() -> None

​

fishaudio.core.request_options

​

RequestOptions Objects

class RequestOptions()

• timeout - Override the client’s default timeout (in seconds)
• max_retries - Override the client’s default max retries
• additional_headers - Additional headers to include in the request
• additional_query_params - Additional query parameters to include

​

get_timeout

def get_timeout() -> Optional[httpx.Timeout]

​

fishaudio.core.iterators

​

AudioStream Objects

class AudioStream()

from fishaudio import FishAudio

client = FishAudio(api_key="...")

# Collect all audio at once
audio = client.tts.stream(text="Hello!").collect()

# Or stream chunks manually
for chunk in client.tts.stream(text="Hello!"):
    process_chunk(chunk)

​

__init__

def __init__(iterator: Iterator[bytes])

• iterator - The underlying iterator of audio bytes

​

__iter__

def __iter__() -> Iterator[bytes]

​

collect

def collect() -> bytes

audio = client.tts.stream(text="Hello!").collect()
with open("output.mp3", "wb") as f:
    f.write(audio)

​

AsyncAudioStream Objects

class AsyncAudioStream()

from fishaudio import AsyncFishAudio

client = AsyncFishAudio(api_key="...")

# Collect all audio at once
stream = await client.tts.stream(text="Hello!")
audio = await stream.collect()

# Or stream chunks manually
async for chunk in await client.tts.stream(text="Hello!"):
    await process_chunk(chunk)

​

__init__

def __init__(async_iterator: AsyncIterator[bytes])

• async_iterator - The underlying async iterator of audio bytes

​

__aiter__

def __aiter__() -> AsyncIterator[bytes]

​

collect

async def collect() -> bytes

stream = await client.tts.stream(text="Hello!")
audio = await stream.collect()
with open("output.mp3", "wb") as f:
    f.write(audio)

​

fishaudio.core.websocket_options

​

WebSocketOptions Objects

class WebSocketOptions()

• keepalive_ping_timeout_seconds - Maximum delay the client will wait for an answer to its Ping event. If the delay is exceeded, WebSocketNetworkError will be raised and the connection closed. Default: 20 seconds.
• keepalive_ping_interval_seconds - Interval at which the client will automatically send a Ping event to keep the connection alive. Set to None to disable this mechanism. Default: 20 seconds.
• max_message_size_bytes - Message size in bytes to receive from the server.
• Default - 65536 bytes (64 KiB).
• queue_size - Size of the queue where received messages will be held until they are consumed. If the queue is full, the client will stop receiving messages from the server until the queue has room available. Default: 512.

​

to_httpx_ws_kwargs

def to_httpx_ws_kwargs() -> dict[str, Any]

​

fishaudio.core.omit