Skip to main content

​
fishaudio.core.omit

OMIT sentinel for distinguishing None from not-provided parameters.

​
fishaudio.core.request_options

Request-level options for API calls.

​
RequestOptions Objects

class RequestOptions()
Options that can be provided on a per-request basis to override client defaults. Attributes:
  • 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]
Convert timeout to httpx.Timeout if set.

​
fishaudio.core.iterators

Audio stream wrappers with collection utilities.

​
AudioStream Objects

class AudioStream()
Wrapper for sync audio byte streams with collection utilities. This class wraps an iterator of audio bytes and provides a convenient .collect() method to gather all chunks into a single bytes object. Examples: 
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])
Initialize the audio iterator wrapper. Arguments:
  • iterator - The underlying iterator of audio bytes

​
__iter__

def __iter__() -> Iterator[bytes]
Allow direct iteration over audio chunks.

​
collect

def collect() -> bytes
Collect all audio chunks into a single bytes object. This consumes the iterator and returns all audio data as bytes. After calling this method, the iterator cannot be used again. Returns: Complete audio data as bytes Examples: 
audio = client.tts.stream(text="Hello!").collect()
with open("output.mp3", "wb") as f:
    f.write(audio)

​
AsyncAudioStream Objects

class AsyncAudioStream()
Wrapper for async audio byte streams with collection utilities. This class wraps an async iterator of audio bytes and provides a convenient .collect() method to gather all chunks into a single bytes object. Examples: 
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])
Initialize the async audio iterator wrapper. Arguments:
  • async_iterator - The underlying async iterator of audio bytes

​
__aiter__

def __aiter__() -> AsyncIterator[bytes]
Allow direct async iteration over audio chunks.

​
collect

async def collect() -> bytes
Collect all audio chunks into a single bytes object. This consumes the async iterator and returns all audio data as bytes. After calling this method, the iterator cannot be used again. Returns: Complete audio data as bytes Examples: 
stream = await client.tts.stream(text="Hello!")
audio = await stream.collect()
with open("output.mp3", "wb") as f:
    f.write(audio)

​
fishaudio.core.client_wrapper

HTTP client wrapper for managing requests and authentication.

​
BaseClientWrapper Objects

class BaseClientWrapper()
Base wrapper with shared logic for sync/async clients.

​
ClientWrapper Objects

class ClientWrapper(BaseClientWrapper)
Wrapper for httpx.Client that handles authentication and error handling.

​
request

def request(method: str,
            path: str,
            *,
            request_options: Optional[RequestOptions] = None,
            **kwargs: Any) -> httpx.Response
Make an HTTP request with error handling. Arguments:
  • method - HTTP method (GET, POST, etc.)
  • path - API endpoint path
  • request_options - Optional request-level overrides
  • **kwargs - Additional arguments to pass to httpx.request
Returns: httpx.Response object Raises:
  • APIError - On non-2xx responses

​
client

@property
def client() -> httpx.Client
Get underlying httpx.Client for advanced usage (e.g., WebSockets).

​
close

def close() -> None
Close the HTTP client.

​
AsyncClientWrapper Objects

class AsyncClientWrapper(BaseClientWrapper)
Wrapper for httpx.AsyncClient that handles authentication and error handling.

​
request

async def request(method: str,
                  path: str,
                  *,
                  request_options: Optional[RequestOptions] = None,
                  **kwargs: Any) -> httpx.Response
Make an async HTTP request with error handling. Arguments:
  • method - HTTP method (GET, POST, etc.)
  • path - API endpoint path
  • request_options - Optional request-level overrides
  • **kwargs - Additional arguments to pass to httpx.request
Returns: httpx.Response object Raises:
  • APIError - On non-2xx responses

​
client

@property
def client() -> httpx.AsyncClient
Get underlying httpx.AsyncClient for advanced usage (e.g., WebSockets).

​
close

async def close() -> None
Close the HTTP client.

​
fishaudio.core.websocket_options

WebSocket-level options for WebSocket connections.

​
WebSocketOptions Objects

class WebSocketOptions()
Options for configuring WebSocket connections. These options are passed directly to httpx_ws’s connect_ws/aconnect_ws functions. For complete documentation, see https://frankie567.github.io/httpx-ws/reference/httpx_ws/ Attributes:
  • 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.
Notes: Parameter descriptions adapted from httpx_ws documentation.

​
to_httpx_ws_kwargs

def to_httpx_ws_kwargs() -> Dict[str, Any]
Convert to kwargs dict for httpx_ws aconnect_ws/connect_ws.