==========================================
Welcome to the Typecast API Documentation!
==========================================

.. important::

    This documentation was updated on |today|.


The Typecast API offers a seamless and versatile solution for integrating advanced voice synthesis into your applications. Our API is designed for simplicity and flexibility, providing you with a wide range of options to bring your digital interactions to life.

Key Features of Typecast API:

- **Diverse Voice Options**: Choose from a wide range of unique voice characters, easily customizable via our `web console <https://biz.typecast.ai>`_ to fit your specific needs.
- **Advanced Speech Synthesis**: Incorporate emotions and fine-tuned control over speech nuances.
- **Flexible Integration**: Utilize our API through polling or webhooks methods.
- **Comprehensive Documentation**: Benefit from detailed guides and references, with continuous updates and additions of new examples.
- **Responsive Support**: Our team is dedicated to providing timely and helpful support for your queries and feedback.

Start exploring the capabilities of Typecast API and transform your application's user experience with lifelike, customizable voice interactions.

Basic guide
===========

This is the most basic guide to using ``POST /api/speak`` to send a speech synthesis request and receive results. |br|
Currently, there are two ways to use it: polling and webhooks.

.. toctree::
   :maxdepth: 2

   guide/index


Advanced speech synthesis
=========================

Guide to using ``POST /api/speak`` for more complex usage, such as expressing emotions or controlling the length of the speech.

.. toctree::
   :maxdepth: 2

   advanced/index


API References
==============

Reference documentation for the full API, including getting a list of characters integrated to your API, registering a Webhook URL, and more.

.. toctree::
   :maxdepth: 2

   reference/index

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

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


.. |api_host| replace:: https://typecast.ai
.. |br| raw:: html

      <br>