Skip to main content
Ragrails reads credentials from environment variables. Use a .env file at the project root or export them in your shell.

Embedding providers

ProviderVariable
VoyageVOYAGE_API_KEY

LLM providers

ProviderVariableModels
OpenAIOPENAI_API_KEYgpt-5.5, gpt-5.4-mini, gpt-4.1, gpt-4o, gpt-4o-mini, and more
AnthropicANTHROPIC_API_KEYclaude-opus-4-8, claude-sonnet-4-6, claude-haiku-4-5, and more
GoogleGEMINI_API_KEY or GOOGLE_API_KEYgemini-3-pro, gemini-2.5-pro, gemini-2.5-flash, gemini-2.5-flash-lite, and more
Google Gemini models don’t support tool calling yet, so they can’t be used with the interactive CLI’s agentic tools.

Reranker providers

ProviderVariable
VoyageVOYAGE_API_KEY
BM25 (local)none, runs offline

Vector databases

ProviderVariables
Qdrant (local)QDRANT_URL (default: http://localhost:6333)
Qdrant (cloud)QDRANT_URL, QDRANT_API_KEY
PineconePINECONE_API_KEY
WeaviateWEAVIATE_URL, WEAVIATE_API_KEY

Loading a .env file

from dotenv import load_dotenv
load_dotenv()

from ragrails import RagRails
rag = RagRails()

URL ingestion

URL ingestion uses Playwright via crawl4ai. Install the extra and run browser setup once per environment:
pip install "ragrails[url]"
RagRails().setup_url()              # installs chromium (default)
RagRails().setup_url(browser="firefox")
Or from the CLI:
ragrails setup-url
ragrails setup-url --browser firefox