Suanlimao
← Back to all tutorials

Connect your tools

Obsidian Copilot plugin

Add a custom provider in Obsidian's Copilot plugin (works on the free tier).

About 5 minFor:Obsidian users who want AI inside their vault

Before you start

  • Obsidian with the Copilot plugin installed and enabled
  • A key and a model name

Step 1 · STEP 0x01

Add a custom provider

Settings → Copilot → BYOK
1
Add a provider
2

Provider

Add a custom provider
Diagram only — the real screen in your version may differ

Open Settings → Copilot → BYOK, click Add a provider and choose Add a custom provider (Ollama and LM Studio are for local models).

Per the docs, BYOK needs no Copilot account, licence key or credit card — the free tier works — and removing a licence does not remove BYOK providers.

Create a key →

Step 2 · STEP 0x02

Enter the key, Base URL and model

Add a custom provider
1

API key

<YOUR_API_KEY>
2

Base URL

https://api.suanlimao.shop/v1
3

Model

Pick from the discovered list or type <MODEL_NAME>
4
Test
5
Save
Diagram only — the real screen in your version may differ
  • Base URL is https://api.suanlimao.shop/v1: the docs say model discovery uses the endpoint's /v1/models, and all examples include /v1.
  • Search the discovered list or type an exact model ID.
  • Click Test; once it shows Verified, click Save.
Don't guess the model name: open the model plaza, click “Copy model id” on a model card and paste it. A wrong model name is the most common error.

Open the model plaza →

Step 3 · STEP 0x03

Use it in Copilot chat

Copilot chat panel
1

Model picker

<MODEL_NAME>
2

Message box

Summarise this note
Diagram only — the real screen in your version may differ
  • Open the Copilot chat panel, pick the model and send a message.
Official tip: if Test passes but Quick Chat cannot send, edit the provider and turn on Enable CORS. Keys live in this device's Obsidian keychain, not the vault's data.json.

✓ How to tell it worked

  • The provider shows Verified, chat answers and the Usage page shows the request.

FAQ

Status says Invalid key?

The key is truncated or revoked.

Status says Check failed?

The docs attribute this to connection or rate-limit problems; hover for details. Check the Base URL is https://api.suanlimao.shop/v1 first.

The model list is empty?

Just type the model ID; the list is optional.

Related tutorials

Still stuck?

Read the troubleshooting tutorials first. If that does not help, open a ticket with the request_id, time, model and the exact error (never paste your key).