Documentation
Features
AI Integration

AI Integration

HeroJournal includes optional AI integration to help you write better achievement descriptions. This feature requires your own API key (Bring Your Own Key).

Supported Providers

Provider Models Notes
OpenAI GPT-4o, GPT-4o-mini Most popular choice
Anthropic Claude Sonnet, Haiku Strong writing quality
Google Gemini Pro, Gemini Flash Good alternative
Ollama Llama, Mistral, etc. Free, runs locally
OpenRouter Multiple models Access many models with one key
Azure AI Foundry Azure-hosted models Enterprise option
Custom Any OpenAI-compatible API Self-hosted solutions

Setting Up AI

Step 1: Open AI Settings

  1. Go to Settings in the sidebar
  2. Click the AI tab
  3. Enable AI integration with the toggle

Step 2: Choose a Provider

Select your preferred AI provider from the dropdown.

Step 3: Enter Your API Key

  1. Get an API key from your chosen provider:
  2. Enter your API key in the secure field
  3. Click Save API Key
Your API key is encrypted and stored locally using your operating system’s secure storage. It never leaves your device except when making API calls.

Step 4: Test Connection

Click Test Connection to verify your API key works correctly.

Using Ollama (Free, Local)

If you prefer not to use cloud AI:

  1. Install Ollama on your computer
  2. Pull a model: ollama pull llama3.2
  3. Select Ollama as your provider in HeroJournal
  4. No API key needed - it runs entirely on your machine

AI Features

Generate Altitude Suggestions

When editing an achievement:

  1. Fill in the Title and optionally Notes
  2. Click the Generate button (sparkle icon) next to any altitude field
  3. AI generates a suggestion based on your achievement context
  4. Review and edit the suggestion as needed

Improve Existing Text

Already have text you want to polish?

  1. Write your initial description
  2. Click the Improve button (wand icon)
  3. AI refines your text while preserving your voice
  4. Accept or reject the suggestion

AI Chat Panel

The AI chat panel (right sidebar) lets you have conversations about your achievements:

  • Ask for suggestions: “How can I make this more impactful?”
  • Get feedback: “Is this too technical for executives?”
  • Request alternatives: “Give me 3 different ways to phrase this metric”

The chat is context-aware:

  • When editing an achievement, AI focuses on that specific achievement
  • In list view, AI considers all visible achievements (respecting filters)

Privacy Considerations

What Gets Sent to AI

When using AI features:

  • Achievement content you’re working on
  • Your request/prompt
  • Basic context (title, notes, existing text)

What Stays Local

  • Your API key (encrypted locally)
  • Your complete achievement history
  • Profile information
  • Settings and preferences

Best Practices

  1. Review AI suggestions before saving
  2. Don’t include sensitive information in achievements that will use AI
  3. Consider Ollama for maximum privacy (runs entirely local)
  4. Use AI as a starting point, not a final answer

Tips for Better AI Results

Provide Context

The more context you give, the better the suggestions:

  • Fill in the title first
  • Add notes about the project
  • Include any metrics you know

Be Specific in Requests

When using chat:

  • “Make this more specific with numbers” works better than “Improve this”
  • “Rewrite for a non-technical executive” gives clearer direction

Iterate

  • Generate multiple options
  • Combine the best parts
  • Always add your personal knowledge

Troubleshooting

“AI not enabled”

  • Check that AI is enabled in Settings
  • Verify your API key is saved

“Connection failed”

  • Check your internet connection
  • Verify your API key is valid and has credits
  • For Ollama: ensure it’s running (ollama serve)

Poor quality suggestions

  • Provide more context (title, notes)
  • Try a different model
  • Be more specific in your request
Last updated on
ExportsGit Sync