# API Key Setup

You need a `data/api_key.csv` file with your API keys. This file is not included in the repository for security reasons.

> **Security Warning:** Never commit your API keys or other secrets to the repository. The `.gitignore` file is configured to exclude `data/api_key.csv` and other sensitive files from version control. Always keep your keys private and secure.

Create `data/api_key.csv` yourself in the following CSV format:

## How to Obtain API Keys

You must sign up with each LLM provider to obtain an API key:

- **OpenAI:** Go to [platform.openai.com/signup](https://platform.openai.com/signup) and create an account. After logging in, visit [API Keys](https://platform.openai.com/api-keys) to generate a key. Use `openai` as the API name.
- **DeepSeek:** Register at [deepseek.com](https://deepseek.com/) and follow their documentation to obtain an API key. Use `deepseek` as the API name.
- **Gemini (Google):** Go to [Google AI Studio](https://aistudio.google.com/) and sign in with your Google account. Create a new API key for the Gemini API. Use `genai` as the API name. This key is required for the new `google-genai` package.
- **PublicAI (Apertus):** Sign up at [publicai.co](https://publicai.co/) to get your API key. Use `publicai` as the API name.

You can also add your [Hugging Face](https://huggingface.co/) token for downloading private or gated models:

```
api,key
openai,sk-...
deepseek,sk-...
genai,YOUR_GOOGLE_KEY
publicai,YOUR_PUBLICAI_KEY
huggingface,hf_xxx...your_token...
```

If you add a `huggingface` entry, the setup scripts will automatically set the `HF_TOKEN` environment variable for you, enabling authenticated model downloads.

The syntax requirements for the `data/api_key.csv` file is strict. Each entry should be on a new line, the API names `openai`, `deepseek`, `genai`, `publicai` and `huggingface` must be exactly as shown and there should be nothing but a comma character `,` separating the API name and the API key. Everything is case sensitive. 

The `api_key.csv` file must be stored in the `data/` directory.