Pipecat API Reference Docs
==========================

Welcome to Pipecat's API reference documentation!

Pipecat is an open source framework for building voice and multimodal assistants.
It provides a flexible pipeline architecture for connecting various AI services,
audio processing, and transport layers.

Quick Links
-----------

* `GitHub Repository <https://github.com/pipecat-ai/pipecat>`_
* `Website <https://pipecat.ai>`_

API Reference
-------------

Core Components
~~~~~~~~~~~~~~~

* :mod:`Frames <pipecat.frames>`
* :mod:`Processors <pipecat.processors>`
* :mod:`Pipeline <pipecat.pipeline>`

Audio Processing
~~~~~~~~~~~~~~~~

* :mod:`Audio <pipecat.audio>`

Services
~~~~~~~~

* :mod:`Services <pipecat.services>`

Transport & Serialization
~~~~~~~~~~~~~~~~~~~~~~~~~

* :mod:`Transports <pipecat.transports>`
   * :mod:`Local <pipecat.transports.local>`
   * :mod:`Network <pipecat.transports.network>`
   * :mod:`Services <pipecat.transports.services>`
* :mod:`Serializers <pipecat.serializers>`

Utilities
~~~~~~~~~

* :mod:`Adapters <pipecat.adapters>`
* :mod:`Clocks <pipecat.clocks>`
* :mod:`Metrics <pipecat.metrics>`
* :mod:`Observers <pipecat.observers>`
* :mod:`Sync <pipecat.sync>`
* :mod:`Transcriptions <pipecat.transcriptions>`
* :mod:`Utils <pipecat.utils>`

.. toctree::
   :maxdepth: 3
   :caption: API Reference
   :hidden:

   Adapters <api/pipecat.adapters>
   Audio <api/pipecat.audio>
   Clocks <api/pipecat.clocks>
   Frames <api/pipecat.frames>
   Metrics <api/pipecat.metrics>
   Observers <api/pipecat.observers>
   Pipeline <api/pipecat.pipeline>
   Processors <api/pipecat.processors>
   Serializers <api/pipecat.serializers>
   Services <api/pipecat.services>
   Sync <api/pipecat.sync>
   Transcriptions <api/pipecat.transcriptions>
   Transports <api/pipecat.transports>
   Utils <api/pipecat.utils>

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`