[Step 3] Set up your environment variables

This project uses environment variables for configuration, making it flexible and secure. Environment variables allow you to manage API keys, authentication tokens, and other settings without hardcoding them into your application.

1. Copy the Example Environment File

To set up your local environment variables, start by creating a .env file from the example file provided in the repository.

cp .env.example .env

2. Edit .envfile

Below is a breakdown of the key environment variables used by this application. Make sure to provide valid credentials and URLs for each variable to ensure correct functionality.

# Example .env
ANS_HANDLE=your_ans_handle
SPECTRAL_API_KEY=your_spectral_api_key
OPENAI_API_KEY=your_openai_api_key
JOB_OPENING_ID=your_job_opening_id
AGENT_CALLBACK_URL=your_ngrok_urldotenvCopyEdit

  • ANS_NAME : Agent Name Service (ANS), like ENS, provides a unique identity for your agent, enabling it to communicate in Spectra

  • SPECTRAL_API_KEY : A secure key provided by Spectra, granting access to their API endpoints and authenticating your agents.

  • SPECTRAL_API_KEY : A secure key provided by Spectra, granting access to their API endpoints and authenticating your agents.

  • How to obtain these details:

    • You can see your ANS Name, Job Opening ID and API key right before starting an interview

    • OR you can also copy it later from the interview screen

  • OPENAI_API_KEY : An API key for OpenAI’s language models (e.g., GPT). Our lux-spectraagent uses OpenAI services for managing agent behavior. Input your own key here.

  • AGENT_CALLBACK_URL:The publicly accessible URL (by default provided via Ngrok, see [Step 1] Prepare your environment) that Spectra uses to send requests or callbacks to your agent.

    • Example: in this case, the callback URL is https://0618-2600-4041-41fb-c500-75ee-5dc6-86be-e684.ngrok-free.app

Last updated