Documentation

Install and First Key

Install Bragi Canvas and connect your first AI provider.

This page gets Bragi installed and connected to at least one provider so you can generate your first result.

Requirements

  • Obsidian desktop app 1.8.7 or newer.
  • Obsidian display language English or English (GB).
  • Bragi does not run on Obsidian mobile.

An API key is like a password that lets Bragi call an AI provider from your account. Bragi does not include provider keys.

Install from Community Plugins

  1. Open Obsidian Settings.
  2. Go to Community plugins. Turn off Restricted mode if needed.
  3. Click Browse and search for Bragi Canvas.
  4. Click Install, then Enable.
Bragi Canvas installed and enabled in a clean demonstration vault.
Bragi Canvas installed and enabled in a clean demonstration vault.

Connect a provider

  1. Open Settings → Bragi Canvas.
  2. Under Providers, click + (Add provider).
  3. Pick a provider you already have an API key for. Common choices include OpenAI, Google Gemini, Anthropic, and fal.ai.
  4. Paste the key fields shown for that provider.
  5. Click through to Select models and enable at least one Image model.
  6. Complete the flow. Configured providers appear in the list.
Choose a provider in Bragi settings, then enter your key and select models.
Choose a provider in Bragi settings, then enter your key and select models.

Some models need a public URL to fetch reference files. Bragi uses temporary cloud storage for that step.

  1. In General, find Temporary cloud → Bragi.
  2. Click Test.
  3. You should see a notice that cloud storage works.

Beta install (advanced)

Use this only if you are testing before a release reaches Community Plugins.

  1. Install the BRAT plugin.
  2. Run BRAT: Add a beta plugin for testing.
  3. Enter https://github.com/nextbound/bragi-canvas.
  4. Enable Bragi Canvas after BRAT installs it.

Manual install (advanced)

  1. Download manifest.json, main.js, and styles.css from the latest GitHub release.
  2. Copy them into:
<vault>/.obsidian/plugins/bragi-canvas/
  1. Restart Obsidian.
  2. Enable Bragi Canvas in Community plugins.

Next step

Continue to Your First Result.

On this page