OpenAI API Quickstart - Python example with FastAPI server

This is an example pet name generator app used in the OpenAI API quickstart tutorial. It uses the FastAPI web framework. Check out the tutorial or follow the instructions below to get set up. It uses the original Flask example from OpenAI as the base but is built with FastAPI instead of Flask.

Setup

1. If you don’t have Python installed, install it from here.

2. Clone this repository.

3. Navigate into the project directory:

   $ cd openai-quickstart-python-fastapi

4. Create a new virtual environment:

   $ python -m venv venv
   $ . venv/bin/activate

5. Install the requirements:

   $ pip install -r requirements.txt

6. Make a copy of the example environment variables file:

   $ cp .env.example .env

7. Add your API key to the newly created .env file.

8. Run the app:

   $ uvicorn.exe main:app

You should now be able to access the app at http://localhost:8000! For the full context behind this example app, check out the tutorial.