> ## Documentation Index
> Fetch the complete documentation index at: https://docs.overcontrolgroup.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Obsidian

> Connect OverControl to Obsidian through Copilot using a custom OpenAI-compatible provider and Lume model.

Use OverControl models inside **Obsidian** through the **Copilot** community plugin.

Copilot supports custom OpenAI-compatible providers, allowing you to connect it to OverControl using your API key, the OverControl Base URL, and a Lume model ID.

<Note>
  OverControl connects to Obsidian through the third-party **Copilot** community plugin.
</Note>

***

## Before you start

You need:

* an [OverControl account](https://app.overcontrolgroup.com/register);
* an OverControl API key;
* Obsidian installed;
* access to Obsidian Community plugins.

<Card title="Open the API dashboard" icon="key" href="https://app.overcontrolgroup.com/dashboard" cta="Open dashboard">
  Create and manage the API key you will use with Obsidian.
</Card>

***

## 1. Enable Community plugins

Open **Obsidian Settings** and select **Community plugins**.

If Obsidian is in **Restricted Mode**, disable Restricted Mode to allow community plugins.

<Frame caption="Disable Restricted Mode to enable Obsidian Community plugins.">
  <img src="https://mintcdn.com/overcontrol/N53KcD41MuPIKsEq/images/obsidian/community-plugins.jpeg?fit=max&auto=format&n=N53KcD41MuPIKsEq&q=85&s=edb3a3fc59b13a718f88ad2d2b881304" alt="Community Plugins" width="1523" height="1191" data-path="images/obsidian/community-plugins.jpeg" />
</Frame>

<Warning>
  Community plugins are third-party software. Review the plugins you install before giving them access to sensitive vaults.
</Warning>

***

## 2. Install Copilot

From **Community plugins**, open the plugin browser and search for:

```text theme={null}
Copilot
```

Install the **Copilot** plugin and enable it.

Once enabled, a **Copilot** section will appear in Obsidian Settings.

***

## 3. Open Copilot settings

Open:

```text theme={null}
Settings → Copilot
```

Go to the section for configuring AI providers and models.

Choose **Add provider** to create a new provider configuration.

<Frame caption="Add a new provider from the Copilot settings.">
  <img src="https://mintcdn.com/overcontrol/N53KcD41MuPIKsEq/images/obsidian/add-provider.jpeg?fit=max&auto=format&n=N53KcD41MuPIKsEq&q=85&s=c4fe6d1e9811d3ee36f53408b48c8555" alt="Add Provider" width="1475" height="1160" data-path="images/obsidian/add-provider.jpeg" />
</Frame>

***

## 4. Add OverControl

Select **Custom OpenAI Compatible** as the provider type.

Enter the OverControl connection values:

| Setting | Value |
| - | - |
| **Provider** | Custom OpenAI Compatible |
| **Base URL** | `https://api.overcontrolgroup.com/v1` |
| **API key** | Your OverControl API key |
| **Model** | `lume-3.5` |

For most Obsidian workflows, start with:

```text theme={null}
lume-3.5
```

<Frame caption="Configure OverControl as a Custom OpenAI Compatible provider.">
  <img src="https://mintcdn.com/overcontrol/N53KcD41MuPIKsEq/images/obsidian/configure-overcontrol.jpeg?fit=max&auto=format&n=N53KcD41MuPIKsEq&q=85&s=c3157463904b0e9620b7510887ea1068" alt="Add Provider" width="1600" height="1214" data-path="images/obsidian/configure-overcontrol.jpeg" />
</Frame>

Save the provider after entering the configuration.

<Warning>
  Keep your API key private. Never expose it in screenshots, logs, public configuration files, or source-control repositories.
</Warning>

***

## 5. Select the Lume model

After adding the provider, select the Lume model in Copilot as the model you want to use.

If you use OverControl regularly, you can also make it your default model.

Then open Copilot chat and send a simple message:

```text theme={null}
Summarize this note in three bullet points.
```

If Copilot returns a response, the integration is working.

***

## Working with Obsidian

Once connected, you can use OverControl inside Copilot for tasks such as:

* summarizing notes;
* rewriting selected text;
* asking questions about note content;
* extracting key information;
* generating outlines;
* drafting new content;
* organizing research;
* working with context from your vault.

<Info>
  Copilot determines which note content, selected text, conversation history, or other context is included in each API request.
</Info>

***

## Choose a model

For most writing, summarization, note analysis, and knowledge workflows, start with **Lume 3.5**.

Use another Lume model when your workflow requires greater reasoning capability, lower cost, or multimodal processing.

[Compare Lume models](/models)

***

## Privacy and your notes

When you use OverControl through Obsidian, Copilot determines which content is sent to the API.

Review the context included in a request before using the integration with sensitive notes or confidential information.

For information about how OverControl processes API requests, see [Privacy and Security](/privacy-security).

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="The API key is rejected">
    Check that your OverControl API key was copied correctly and has not been revoked.

    ```text theme={null}
    You can create or manage keys from the [API dashboard](https://app.overcontrolgroup.com/dashboard).
    ```
  </Accordion>

  <Accordion title="Copilot cannot connect">
    Confirm that **Custom OpenAI Compatible** is selected and that the Base URL is:

    ````text theme={null}
    ```text
    https://api.overcontrolgroup.com/v1
    ```

    Then check your API key and provider configuration.
    ````
  </Accordion>

  <Accordion title="The model is not found">
    Make sure the model ID is entered exactly as documented.

    ````text theme={null}
    For example:

    ```text
    lume-3.5
    ```

    [View available models](/models)
    ````
  </Accordion>

  <Accordion title="The model does not appear in Copilot">
    Make sure the provider was saved successfully and that the Lume model is enabled or selected in Copilot's model settings.
  </Accordion>

  <Accordion title="Requests fail after working previously">
    Check your selected model, API key, available quota or balance, and API usage in the OverControl dashboard.
  </Accordion>
</AccordionGroup>

***

## Next steps

<CardGroup cols={3}>
  <Card title="Notes and knowledge" icon="book-open" href="/integrations/notes-and-knowledge">
    Return to the notes and knowledge integrations overview.
  </Card>

  <Card title="Models" icon="brain" href="/models">
    Choose the Lume model for your Obsidian workflow.
  </Card>

  <Card title="Integrations" icon="plug" href="/integrations">
    Explore all supported integrations.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.