Setup

Let’s set up Logseq Copilot in less than 5 minutes.

Logseq Copilot talks to the HTTP API server of the Logseq desktop app, so you set up two things: the server in Logseq, then the connection in the extension.

Which Logseq?

Logseq	Graph type	Supported
0.10.x	File graph (Markdown or Org files on disk)	Yes
2.x	DB graph	Yes

There is no setting for the graph type. After you connect, the extension asks Logseq which kind of graph is open and uses the matching search. If you switch graphs in Logseq, the next search follows.

Note

The screenshots below were taken in Logseq 2.x, and the extension’s options page now has the new teal look. The steps are the same in Logseq 0.10.x, where Logseq’s own menus can look a little different.

Setup Logseq API Server

Enable API Service

1. Open Logseq Settings.

   

2. Go to Features → Enable HTTP APIs Server

   

Setting Authorization Token

1. Go to logseq copilot tool bar, Click API icon.

   

2. Click Authorization tokens.

   

3. Click Add new token.

   

4. You will see a row as below.

   

5. Fill name as logseq-copilot, value is a secret, eg. secret-value, then click Save.

   

Security Note

The value of Authorization token is a secret string. We suggest setting it to a random string for security.

Setting API Server Auto Start

1. Go to logseq copilot tool bar, Click API icon.

   

2. Click Server configurations.

   

3. Toggle on Auto start server with the app launched.

   

4. Click Start Server to start the API server.

   

Setup Browser Extension

Connect to Logseq

1. Open the Logseq Copilot extension options page.

   

2. Enter your Logseq API server details:

   • Host: Usually localhost
   • Port: Usually 12315
   • Authorization Token: The token you created earlier

   

3. The extension saves the values as you type and checks the connection a moment after you stop typing. Click Connect to check it right away. Logseq also pops up a “Logseq Copilot Connect!” message.

   

4. You should see Connected to Logseq v…! on the button when it works. A link to open your graph in Logseq shows up next to it.

   

Verification

To verify that everything is working correctly:

1. Check API Server Status: Make sure the Logseq API server is running
2. Test Connection: The Connect button on the Settings page should say “Connected to Logseq v…!”
3. Try a search: Search for a word from one of your notes on Google. A Logseq panel with matching notes should show up next to the results.
4. Try the sidebar: Click the Logseq Copilot icon in the toolbar of any web page. The sidebar opens and lists the notes that mention that page, if there are any.

Troubleshooting

Common Issues

• Connection Failed: Check if the Logseq API server is running and a graph is open in Logseq
• Wrong Host or Port: Make sure they match the API server (usually localhost and 12315)
• Invalid Token: Verify that the authorization token matches exactly
• Firewall Issues: Check if your firewall is blocking the connection
• Nothing shows up on a page: Reload pages that were open before you installed or updated the extension

Getting Help

If you’re still having trouble:

• Check our GitHub Discussions
• Make sure both Logseq and the browser extension are up to date
• Try restarting both Logseq and your browser

Next Steps

Once everything is set up:

• Choose the search engines you use →
• Set up your clip template →
• Learn about the Sidebar →
• Discover Highlight Comments →