LogoIRIS
BYOK DOCUMENTATION

API Configuration.

IRIS operates on a strictly local Bring Your Own Key (BYOK) architecture. Acquire the required API keys below to enable external inference and data extraction.

How to apply your keys

You do not need to configure environment variables. Simply copy the generated key from the provider and paste it directly into the Settings Tab within the IRIS Desktop Application.

Google Gemini API

Required

Primary LLM provider required for core execution and natural language processing.

Acquisition Steps

  • 1.Navigate to Google AI Studio.
  • 2.Sign in with your Google Account.
  • 3.Click 'Get API Key' in the left sidebar.
  • 4.Create a key in a new or existing project.
Get Gemini Key

Groq API

Required

Required for high-speed LPU inference and split-second tool-calling logic.

Acquisition Steps

  • 1.Go to the Groq Cloud Console.
  • 2.Log in or create an account.
  • 3.Navigate to the 'API Keys' section.
  • 4.Click 'Create API Key' and copy it immediately.
Get Groq Key

Tavily Search API

Optional

Required for autonomous web crawling and real-time search data extraction.

Acquisition Steps

  • 1.Sign up at the Tavily Developer Portal.
  • 2.Navigate to your dashboard.
  • 3.Generate a new API key (Free tier available).
Get Tavily Key

Hugging Face Token

Optional

Required for accessing open-source visual models and local image generation.

Acquisition Steps

  • 1.Create a Hugging Face account.
  • 2.Go to Settings > Access Tokens.
  • 3.Create a new token with 'Read' permissions.
Get Hugging Face Token