Skip to content

Getting Started with Call Chat Agents

Welcome to the Call Chat Agents documentation! This guide will help you set up the project and get started with using the FastAPI application.

Prerequisites

Before you begin, ensure you have the following installed:

  • Python 3.7 or higher
  • pip (Python package installer)

Installation

  1. Clone the Repository

Start by cloning the repository to your local machine:

git clone https://github.com/yourusername/call-chat-agents.git cd call-chat-agents

  1. Install Dependencies

Add MkDocs and other required libraries to your requirements.txt file if not already present. You can use the following command to install the dependencies:

pip install -r requirements.txt

  1. Set Up Environment Variables

Create a .env file in the root directory of the project and add your LiveKit API credentials:

LIVEKIT_API_KEY=your_api_key LIVEKIT_API_SECRET=your_api_secret LIVEKIT_URL=your_livekit_url

Replace your_api_key, your_api_secret, and your_livekit_url with your actual LiveKit credentials.

Running the Application

  1. Start the FastAPI Application

You can run the FastAPI application using the following command:

uvicorn app.main:app --reload

This will start the server at http://127.0.0.1:8000.

  1. Access the API Documentation

Once the server is running, you can access the interactive API documentation at:

http://127.0.0.1:8000/docs

Serving Documentation

To serve the documentation locally, navigate to the project directory and run:

mkdocs serve

This will start a local server for the documentation, typically at http://127.0.0.1:8000.

Building Documentation

When you're ready to deploy the documentation, run the following command to generate static HTML files:

mkdocs build

The generated files will be located in the site directory.

Next Steps

Now that you have set up the project, you can explore the usage documentation to learn how to interact with the API and utilize the features of the Call Chat Agents application.