mohammed-saalim / orahacks-api

AI Interview API

Introduction

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.

API Deployment

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.

Key Endpoint

• /evaluate: A POST endpoint that accepts interview answers, communicates with OpenAI for processing, and returns detailed feedback and scores to the front-end application.

Setup and Local Development

To set up and run this project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/mohammed-saalim/orahacks-api.git
   cd orahacks-api

2. Install dependencies: pip install -r requirements.txt

3. Set Environment Variable in heroku/local For local create a .env file and add OPENAI_API_KEY=your_openai_api_key

4. Run Server flask run

Deploying on Heroku

To deploy your own instance of this API on Heroku, follow these instructions:

Install the Heroku CLI and log in to your Heroku account.

Create a new app on Heroku: heroku create

Set the OpenAI API key as a Heroku config var:

heroku config:set OPENAI_API_KEY=your_openai_api_key

Deploy the application using Git:

git push heroku master

Front-end Repository

The front-end React application that interacts with this API is hosted separately. You can find the repository here: AI Interview UI

Contributions

We welcome contributions to this project. If you have suggestions or improvements, please fork the repository and submit a pull request.

Showcasing

The project was showcased at OraHacks "Back to the Future" event. Check out the LinkedIn post about this event here. here

Screenshots