Skip to main content

Usage

NoteSmith lets you use AI (via the OpenAI API or a compatible endpoint) to revise, summarize, or transform entire notes in Obsidian with just a few clicks. This guide walks you through everything you need to know.

⚙️Settings​

Customize the plugin under Settings → NoteSmith:

  • API Key — Your OpenAI secret key (or compatible provider)
  • Model — Choose any supported model (e.g., gpt-4, gpt-3.5-turbo, or others)
  • API URL — Useful for custom endpoints like LocalAI, Mistral, Azure, etc.
  • Tags — Tags in you'd like added to your notes where applicable (e.g., #todo, #idea)
  • Additional Instructions — Global notes passed to the prompt to tailor all responses

These options give you control over both the backend service and the tone or focus of the AI output.

✨ Basic Usage​

Once you've installed NoteSmith and configured your API settings, you're ready to start editing.

🔄 Run a Default Rewrite​

  1. Open any note you want to revise
  2. Press Ctrl+P (or Cmd+P on Mac) to open the Command Palette
  3. Run NoteSmith: Refine Current Note
  4. The plugin will:
  • Send your note's content to your configured API endpoint
  • Apply the prompt with your additional instructions
  • Replace your note with the AI-generated version

✅ Obsidian's built-in undo functionality lets you easily revert changes if needed.

🖱 Right-Click Menu​

Prefer using the mouse?

  1. Right-click inside any note
  2. Navigate to NoteSmith → Rewrite with NoteSmith

🧼 Undo and Recovery​

NoteSmith doesn’t maintain its own version history — but:

  • Obsidian's undo stack retains the original content
  • Just press Ctrl+Z / Cmd+Z to undo any change

📖 Summary​

NoteSmith helps you polish and rethink your notes with AI:

✅ Edit entire notes with one command 🧠 Pass in additional instructions for tailored output 🏷 Leverage Obsidian tags for context

Let it clean up your thoughts — so you can focus on capturing them.

Need help writing prompts, or want to use a local model like Mistral? Open an issue on GitHub!