Setup with OpenAI (and OpenAI‐compatible) - travisvn/obsidian-vision-recall GitHub Wiki
Setting Up Vision Recall with OpenAI and Compatible Providers
Vision Recall supports OpenAI and other compatible API providers like OpenRouter and Groq. This guide will help you set up these services for use with Vision Recall.
OpenAI Setup
Prerequisites
-
OpenAI Account:
- Create an account at platform.openai.com
- Ensure you have billing set up (OpenAI requires a payment method)
-
Get API Key:
- Log in to your OpenAI account
- Navigate to API Keys
- Click "Create new secret key"
- Copy your API key
Configuration in Vision Recall
-
Open Vision Recall Settings:
- Go to Obsidian Settings → Vision Recall
-
Configure LLM Provider:
- Set LLM Provider to
OpenAI
- Paste your API key in the API Key field
- Leave API Base URL as default (
https://api.openai.com/v1
) - Select a vision-capable model (e.g.,
gpt-4o
) as your vision model - Select a regular (or vision-capable) model for your
endpoint
model
- Set LLM Provider to
-
Test Connection:
- Click the Test config button in the main view to verify your API key works
- If successful, you'll see a list of available models
OpenRouter Setup
OpenRouter allows you to access various AI models, including those from Anthropic, Google, and more.
Prerequisites
-
OpenRouter Account:
- Create an account at openrouter.ai
- Add credits to your account
-
Get API Key:
- Log in to your OpenRouter account
- Navigate to the API Keys section
- Create and copy your API key
Configuration in Vision Recall
-
Open Vision Recall Settings:
- Go to Obsidian Settings → Vision Recall
-
Configure LLM Provider:
- Set LLM Provider to
OpenAI
- Paste your OpenRouter API key in the API Key field
- Set API Base URL to
https://openrouter.ai/api/v1
- Select a vision-capable model from the Model dropdown
- Set LLM Provider to
-
Test Connection:
- Click the Test Connection button to verify your setup
Groq Setup
Groq offers fast inference for language models.
Prerequisites
-
Groq Account:
- Create an account at console.groq.com
-
Get API Key:
- Log in to your Groq account
- Navigate to the API Keys section
- Create and copy your API key
Configuration in Vision Recall
-
Open Vision Recall Settings:
- Go to Obsidian Settings → Vision Recall
-
Configure LLM Provider:
- Set LLM Provider to
OpenAI
- Paste your Groq API key in the API Key field
- Set API Base URL to
https://api.groq.com/openai/v1
- Select a compatible model from the Model dropdown
- Set LLM Provider to
-
Test Connection:
- Click the Test Connection button to verify your setup
Other Compatible Providers
Vision Recall works with any provider that offers an OpenAI-compatible API. To configure:
- Set LLM Provider to
OpenAI
- Enter your provider's API key
- Set the API Base URL to your provider's endpoint
- Select an appropriate model
Cost Considerations
- OpenAI and other providers charge based on usage
- Vision models typically cost more than text-only models
- Monitor your usage to avoid unexpected charges
- Consider using Ollama for a free, local alternative if cost is a concern
Security Note
Your API keys grant access to paid services. Keep them secure:
- Never share your API keys
- Don't commit them to public repositories
- Consider using environment variables or a secure vault for storage