OmniFlows Lab

OmniFlows guide

Obsidian Integration Guide

Set up the Local REST API to connect OmniFlows to your vault.

1

Install Local REST API

OmniFlows communicates with Obsidian using the Local REST API community plugin.

  1. Open Obsidian Settings and go to Community plugins.
  2. Click Browse and search for Local REST API.
  3. Click Install and then Enable.
2

Get your API key

Once enabled, copy the authorization token.

  1. Go to the Local REST API settings within Obsidian.
  2. Find the API Key section.
  3. Click Copy or manually copy the long string of characters.
3

Configure OmniFlows

Open the OmniFlows extension Options page and fill in the details.

  • Protocol: choose http.
  • Port: usually 27123. Check your plugin settings if unsure.
  • API Key: paste the key copied in Step 2.
!

Troubleshooting

  • Protocol mismatch: ensure you selected http in OmniFlows. HTTPS is currently not supported due to browser security restrictions on local self-signed certificates.
  • Plugin status: ensure the plugin status in Obsidian is active.
  • Port conflict: check whether another application is using the same port.