API reference

Flowcat is a set of Rust crates; the canonical, type-level API reference is rustdoc.

Not yet on crates.io / docs.rs. Flowcat is pre-1.0 and not yet published, so there is no docs.rs page yet. Until then, generate the docs locally — it takes seconds. (When published, the hosted link will live here.)

Generate the docs locally

git clone https://github.com/AreevAI/flowcat.git
cd flowcat

# Core seams (no provider features needed):
cargo doc --no-deps -p flowcat-core --open

# Include the provider/transport surface (enable the features you care about):
cargo doc --no-deps \
  -p flowcat-core -p flowcat-services -p flowcat-transports -p flowcat-telephony \
  --features "flowcat-services/realtime-all,flowcat-transports/ws"

Feature-gated items only appear in rustdoc when their feature is enabled — pass the same features you'd build with (see Deployment).

Crate map

CrateWhat it exposes
flowcat-coreThe seams and runtime: AgentBrain, SessionSource, MediaTransport, RealtimeLlm / RealtimeKickoff, the FrameProcessor graph + Frame taxonomy, build_s2s_task / build_cascaded_task, native SipAgent / SipTransport, and the GeminiLive backend
flowcat-servicesSTT / TTS / LLM / realtime provider adapters (feature-gated), observability exporters, the RemoteBrain HTTP adapter (brain-http)
flowcat-transportsWebRTC (webrtc-str0m), WebSocket (ws), and other media transports
flowcat-telephonyCarrier serializers (Plivo, Twilio, Telnyx, …) and DTMF
flowcat-cliThe credential-free flowcat demo binary (pipeline, ws-echo)

Starting points