Anki²

An Anki add-on that enhances card creation by integrating AI and external APIs to provide rich content for your flashcards.

• Anki²
  • Features
  • Quick Start
    • Installation
  • Usage
  • Configuration
    • Obtaining API Keys
      • Bing Image Search API
      • Forvo API
      • OpenAI API
  • Contributing
  • License

Features

🖼️ Images

• Fetch relevant images from Bing Image Search
• Automatically download and embed in cards
• Configurable number of images per card

🗣️ Pronunciations

• Get native speaker pronunciations from Forvo
• Support for 40+ languages

🤖 AI-Powered Content

• Generate example sentences
• Create concise definitions
• Generate IPA transcriptions
• Adjustable difficulty levels (A1-C2)

Quick Start

Installation

From AnkiWeb:

1. Open Anki
2. Tools → Add-ons → Get Add-ons...
3. Paste code: 517882364
4. Restart Anki

From Source:

# Clone repository
git clone https://github.com/jqhoogland/ankisquared.git

make install

Usage

1. Open Anki and navigate to the card editor
2. Type your word/phrase in the front field
3. Use the toolbar buttons or keyboard shortcuts:
   • Ctrl+Shift+1: Add images
   • Ctrl+Shift+2: Add pronunciation
   • Ctrl+Shift+3: Add example sentences
   • Ctrl+Shift+4: Add definition
   • Ctrl+Shift+5: Add IPA

Configuration

1. Tools → Add-ons → Anki² → Config
2. Configure your API keys:

   {
     "bing_api_key": "your-bing-api-key",
     "forvo_api_key": "your-forvo-api-key",
     "openai_api_key": "your-openai-api-key"
   }

Obtaining API Keys

Bing Image Search API

1. Sign up for a Microsoft Azure account
2. Create a Bing Images Search resource in the Azure portal and select the Free F1 tier.
3. Go to "Manage keys" in your resource
4. Copy either Key 1 or Key 2 as your bing_api_key

Forvo API

1. Register for a Forvo account
2. Subscribe to an API plan (they offer a free trial)
3. Get your API key from your Forvo account dashboard
4. Use this as your forvo_api_key

OpenAI API

1. Create an OpenAI account
2. Go to API Keys
3. Click "Create new secret key"
4. Copy the key immediately (you won't be able to see it again)
5. Use this as your openai_api_key

Note: Keep your API keys secure and never share them publicly. The add-on stores them locally in your Anki configuration.

Contributing

• User Guide
• Configuration
• API Documentation
• Contributing Guide

License

MIT License - see LICENSE file