Assistant Setting Up

Last modified: 07/03/2026

Overview

Use this page to set up Sprig (Sprout's AI assistant) safely before first use.

1. Enable Sprig

Open Settings -> Assistant and turn on Enable Sprig.

Sprig will not run until it is enabled and an API key is configured.

2. Choose provider and model

In Settings -> Assistant -> AI Provider:

• Choose a provider: Anthropic, DeepSeek, Groq, OpenAI, or Custom.
• Choose a model for that provider.
• If using Custom, set Endpoint override to your provider URL.

3. Add API key

Add the API key field for your current provider.

Sprig stores keys locally at:

/.obsidian/plugins/sprout/configuration/api-keys.json

4. Protect your key in Git

If your vault or .obsidian directory is tracked by Git, add only this file to .gitignore:

.obsidian/plugins/sprout/configuration/api-keys.json

5. Understand risks before use

Sprig is a draft assistant and can hallucinate or be wrong.

Before relying on responses or generated cards:

• Verify key facts against your source notes.
• Edit wording and difficulty.
• Remove content that is unsafe, low quality, or off-topic.

Read the full policy: AI Usage Policy

Setup checklist

• Sprig enabled
• Provider selected
• Model selected
• API key saved
• .gitignore includes configuration/api-keys.json only (if needed)
• AI policy reviewed