# Obsidian URL Deeplinks Obsidian URL deeplinks are custom protocol URLs (`obsidian://`) that open specific vaults, files, or actions directly in [[Obsidian]]. They work from external apps, browsers, bookmarks, and scripts, making it possible to reference and jump to vault content from anywhere. ## URI Format The base format is: ``` obsidian://action?param1=value1&param2=value2 ``` All parameter values must be URI-encoded. ## Common Actions ### Open a vault ``` obsidian://open?vault=MyVault ``` ### Open a specific file ``` obsidian://open?vault=MyVault&file=path/to/note ``` The file path is relative to the vault root, without the `.md` extension. ### Open a file and jump to a heading Append a URL-encoded `#` to target a heading: ``` obsidian://open?vault=MyVault&file=note%23heading ``` ### Search ``` obsidian://search?vault=MyVault&query=search+term ``` ### Create a new note ``` obsidian://new?vault=MyVault&name=New+Note&content=Initial+content ``` Optional parameters: `path` (folder), `overwrite`, `append`. ## Getting a Deeplink In Obsidian, use the [[Obsidian Command Palette]] and run **Copy Obsidian URL** to copy the `obsidian://` URL for the current file to your clipboard. This is the easiest way to generate a deeplink. ## Use Cases - **External task managers**: link tasks back to relevant notes - **Bookmarks**: save vault entry points in your browser - **Scripts and automation**: open specific notes from shell scripts, [[Obsidian CLI]], or workflow tools - **Cross-app references**: link from calendar events, emails, or documents to vault notes - **Quick capture workflows**: create new notes from external triggers ## Limitations - Deeplinks only work on machines where Obsidian is installed and the target vault is available - The `obsidian://` protocol must be registered with the OS (Obsidian does this on install) - Vault names with special characters need URI encoding ## References - Official documentation: https://help.obsidian.md/Extending+Obsidian/Obsidian+URI ## Related - [[Obsidian]] - [[Obsidian CLI]] - [[Obsidian Command Palette]] - [[Obsidian Keyboard Shortcuts]] - [[AdvancedURI plugin for Obsidian]] - [[How to create deep links in Obsidian]] - [[Obsidian Starter Kit]]