Xiaohan-Tian
52 lines
3.3 KiB
Markdown
52 lines
3.3 KiB
Markdown
## Welcome
|
|
|
|
Welcome to **K.G.Studio Musician Assistant**—your AI-powered agent for music composition and arrangement. Harnessing advanced language models, I am here to help you create, arrange, and refine your musical ideas with ease and intelligence.
|
|
|
|
To get started, you will need to configure an LLM (Large Language Model) Provider in the application settings. Please follow the instructions below to ensure proper setup:
|
|
|
|
---
|
|
|
|
### Configuring Your LLM Provider
|
|
|
|
Navigate to **Settings ⚙️ → General → LLM Provider**. Depending on your chosen provider, you will need to supply the appropriate API Key and, if applicable, a custom base URL (for non-official OpenAI-compatible services such as Ollama, OpenRouter, etc.).
|
|
|
|
---
|
|
|
|
### Using the OpenAI GPT Model Series
|
|
|
|
1. Obtain an OpenAI API Key from [**OpenAI**](https://platform.openai.com/account/api-keys). You may need to create an account and add a payment method to generate an API Key.
|
|
2. In **Settings ⚙️ → General → LLM Provider**, select **OpenAI** as your provider.
|
|
3. Enter your API Key in **OpenAI → Key**.
|
|
4. Select your preferred model from the **OpenAI → Model** dropdown. For optimal performance, we recommend `gpt-5` or `gpt-4o`.
|
|
5. Optionally, choose whether to enable Flex Mode in **OpenAI → Flex Mode**. Flex Mode offers discounted pricing, but may result in slower response times.
|
|
|
|
---
|
|
|
|
### Using OpenRouter
|
|
|
|
OpenRouter is a platform that provides unified access to a wide range of language models—including free options—from various providers. This makes it easy to experiment and find the model that best suits your needs.
|
|
|
|
1. Obtain an API Key from [**OpenRouter**](https://openrouter.ai/keys). Registration is required; for paid models, a payment method may also be necessary.
|
|
2. In **Settings ⚙️ → General → LLM Provider**, select **OpenAI Compatible** as your provider.
|
|
3. Enter your API Key in **OpenAI Compatible Server → Key**.
|
|
4. Browse available models on the [**OpenRouter Models Page**](https://openrouter.ai/models). Use the "Prompt Pricing" filter to identify free models.
|
|
**Note:** Each model provider may have different data retention and privacy policies. Please review these policies before use.
|
|
5. Enter your chosen model name in **OpenAI Compatible Server → Model**. Recommended model series include:
|
|
- `Google: gemini-2.5-pro`
|
|
- `Anthropic: claude-4-sonnet`
|
|
- `DeepSeek: deepseek-r1` (free: `deepseek/deepseek-r1-0528:free`)
|
|
- `DeepSeek: deepseek-v3` (free: `deepseek/deepseek-chat-v3-0324:free`)
|
|
- `Qwen: qwen3-235b-a22b` (free: `qwen/qwen3-235b-a22b:free`)
|
|
6. Input the base URL `https://openrouter.ai/api/v1/chat/completions` of the OpenAI Compatible Server in **OpenAI Compatible Server → Base URL**.
|
|
|
|
---
|
|
|
|
### Note
|
|
|
|
Due to security reasons, if you are using K.G.Studio from a non-local hosted environment, we won't persist your API Key in your browser's IndexedDB in order to prevent potential XSS attack, you will need to input your API Key every time you start K.G.Studio.
|
|
|
|
### Disclaimer
|
|
|
|
K.G.Studio does not provide or host any of the models listed above, nor is it affiliated with any model provider. All data is stored locally on your device; K.G.Studio does not collect or transmit your data. You are solely responsible for any data you provide to third-party model providers.
|
|
|
|
We hope you enjoy using K.G.Studio Musician Assistant! |