This repository hosts the Flask API for the AI Interview Platform, a powerful tool designed to automate the interview process using AI. It evaluates interview responses by leveraging OpenAI's GPT models to provide scores and detailed feedback. This project was demonstrated at the OraHacks hackathon.
The API is currently deployed on Heroku and can be accessed here: AI Interview API. This deployment serves as the backend for the interview platform, handling requests and processing data.
- /evaluate: A POST endpoint that accepts interview answers, communicates with OpenAI for processing, and returns detailed feedback and scores to the front-end application.
To set up and run this project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/mohammed-saalim/orahacks-api.git cd orahacks-api
-
Install dependencies: pip install -r requirements.txt
-
Set Environment Variable in heroku/local For local create a .env file and add OPENAI_API_KEY=your_openai_api_key
-
Run Server flask run
To deploy your own instance of this API on Heroku, follow these instructions:
Create a new app on Heroku: heroku create
heroku config:set OPENAI_API_KEY=your_openai_api_key
git push heroku master
The front-end React application that interacts with this API is hosted separately. You can find the repository here: AI Interview UI
We welcome contributions to this project. If you have suggestions or improvements, please fork the repository and submit a pull request.
![Screenshot 2024-05-14 at 10 05 17 PM](https://private-user-images.githubusercontent.com/53993039/330668576-614d8565-dfe3-4358-a6d3-479694f791cd.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQwMzQwNjEsIm5iZiI6MTcyNDAzMzc2MSwicGF0aCI6Ii81Mzk5MzAzOS8zMzA2Njg1NzYtNjE0ZDg1NjUtZGZlMy00MzU4LWE2ZDMtNDc5Njk0Zjc5MWNkLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODE5VDAyMTYwMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTdjZmFhZGRmMzMzYTI1MDM3M2U3M2IyZTk5NjU2OGNmZDdlODRmMTUyNmZmNjY3YWY5YjgyZDVlNzNkMDM1ZGEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.G5WWPhUVr-TYcJPKBDMYS9wWQkgz7jAUcpb-bMKxpMg)
![Screenshot 2024-05-14 at 10 05 50 PM](https://private-user-images.githubusercontent.com/53993039/330668640-488ab751-fdd2-476c-8523-8c02fd5c4818.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQwMzQwNjEsIm5iZiI6MTcyNDAzMzc2MSwicGF0aCI6Ii81Mzk5MzAzOS8zMzA2Njg2NDAtNDg4YWI3NTEtZmRkMi00NzZjLTg1MjMtOGMwMmZkNWM0ODE4LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODE5VDAyMTYwMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWZkMzdlZjJjMzBiOTIzMjE3MjdlOWNlYzMxMjAyY2EzNTRlNDRjYjI5MzM2MWFjNDZmNjA0YzhmNjMwZWYxYjMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.9gIbHAKbGSO6c6dv5u-CtDXq9EPNRQhkZhOOe_iqlCI)
![Screenshot 2024-05-14 at 11 53 42 PM](https://private-user-images.githubusercontent.com/53993039/330668515-4cfa8699-3166-48ca-bd4d-1a1aacd4a314.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQwMzQwNjEsIm5iZiI6MTcyNDAzMzc2MSwicGF0aCI6Ii81Mzk5MzAzOS8zMzA2Njg1MTUtNGNmYTg2OTktMzE2Ni00OGNhLWJkNGQtMWExYWFjZDRhMzE0LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODE5VDAyMTYwMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTMwM2FkNjA2NTIwZTc4MzI5ZGY5MmVlNDJkZmIxYTc3YjJhZjAzMTBmZWUwMTQ5MmI2MzljNDVmZDRmZGMwYzAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.plsAc8ZU2q3owNAvcWkCeowiaCXrlEZdysMGXgsrS8U)
![Screenshot 2024-05-14 at 11 54 08 PM](https://private-user-images.githubusercontent.com/53993039/330668501-744f236a-f948-4aa9-a034-1f26bcdd82c6.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQwMzQwNjEsIm5iZiI6MTcyNDAzMzc2MSwicGF0aCI6Ii81Mzk5MzAzOS8zMzA2Njg1MDEtNzQ0ZjIzNmEtZjk0OC00YWE5LWEwMzQtMWYyNmJjZGQ4MmM2LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODE5VDAyMTYwMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTNkOWQ4OGI1ZjVkZmJmNmRlZWE4NWM3ZWJmZTcxMDNlOTY1MGU1ZTE5ZDQ0OGQxY2ZmMjJhM2EyNzVmYjViYTYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.Atjr78waR_TE7UbyslNPgOhHHCV5bU5hrFf9aYn3yK8)