Installation

Use this page for first install, updates, initial account setup, and the screenshots needed to document the setup flow.

Contents

• Quick start
• Requirements and compatibility
• Installation
• Initial setup
• Updating
• Removing the integration
• Related pages

Quick start

1. Install Groq through HACS as a custom repository, or copy custom_components/groq manually.
2. Restart Home Assistant.
3. Add the Groq integration from Settings -> Devices and services -> Add integration.
4. Enter a friendly account name and a Groq API key from the Groq Console.
5. Open the Groq integration page and add at least one named service entry.

Requirements and compatibility

• A recent Home Assistant version with config subentry support.
• A Groq API key from the Groq Console.
• Network access from Home Assistant to https://api.groq.com.
• ffmpeg on the Home Assistant host only if you enable Text-to-Speech audio normalization.

Installation

Recommended: HACS

Step	Screenshot
1. In Home Assistant, open HACS -> Integrations -> Custom repositories. Add https://github.com/barneyonline/ha-groq as an Integration repository.
2. Open the Groq repository entry in HACS and download it.
3. Restart Home Assistant when HACS prompts you.
4. Go to Settings -> Devices and services -> Add integration and select Groq.

Alternative: Manual copy

1. Download or clone the repository.
2. Copy custom_components/groq into your Home Assistant custom_components directory.

<homeassistant_config_dir>/
  custom_components/
    groq/
      __init__.py
      manifest.json
      ...

3. Restart Home Assistant.
4. Go to Settings -> Devices and services -> Add integration -> Groq.
5. Enter a friendly account name and your Groq API key.

Initial setup

The first setup flow creates a Groq account entry. Service-specific behavior is added afterwards from the integration page.

Step	Screenshot
1. Enter a friendly Groq account name and API key.
2. Open the created Groq integration entry.
3. Choose the service button you want to add: Text Generation, Speech-to-Text, Text-to-Speech, or Image Recognition.

Use Account and Service Setup for service names, multiple accounts, model discovery, and reauthentication.

Updating

When installed through HACS, update the integration from HACS and restart Home Assistant.

For manual installs, replace the custom_components/groq directory with the updated version and restart Home Assistant.

After updating, review your service entries if release notes mention model, capability, or option changes.

Removing the integration

• Go to Settings -> Devices and services -> Integrations.
• Locate Groq and delete the integration entry to remove the account and service entries.
• If installed through HACS, remove the HACS repository entry after deleting the integration from Home Assistant.

Related pages

• Account and Service Setup
• Text Generation
• Troubleshooting