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

# SiYuan

[SiYuan](https://github.com/siyuan-note/siyuan) is a privacy-first personal knowledge management system with block-level Markdown editing and built-in AI writing and Q\&A. Its AI settings accept a custom OpenAI-compatible endpoint, so you can point them to the ScitiX Model Inference API.

The steps below reflect SiYuan's current AI settings. Newer versions may differ slightly. For available models, such as `glm-5.2` and `DeepSeek-V4-Flash`, and pricing, see the [model catalog](https://console.scitix.ai/model-inference/models).

## Configure

Create an API Key on the [API Keys](https://console.scitix.ai/model-inference/api_keys) page first.

### 1. Add the provider

Open **Settings → Artificial Intelligence**, add a provider through the **Add provider** dialog, and fill in the required fields.

| Field               | Value                                                                                            |
| ------------------- | ------------------------------------------------------------------------------------------------ |
| API Base URL        | `https://api.scitix.ai/model-api/v1`                                                             |
| Custom display name | `scitix` (optional)                                                                              |
| API Key             | Your API Key created on the [API Keys](https://console.scitix.ai/model-inference/api_keys) page. |

The dialog notes that the actual endpoint is `/chat/completions` under this address, so the API Base URL ends with `/v1`.

<img src="https://mintcdn.com/scitix-adfc65c2/_I6H7WpAVXPiLIwE/model-inference/media/siyuan-add-provider.png?fit=max&auto=format&n=_I6H7WpAVXPiLIwE&q=85&s=2662ddff061227d4e555213b73f95a7b" alt="SiYuan — Add provider dialog pointed at ScitiX" width="2418" height="1360" data-path="model-inference/media/siyuan-add-provider.png" />

### 2. Add the model

Add a model under the ScitiX provider through the **Add model** dialog. Set **Model name** to `glm-5.2`, or click **Fetch available models**.

Click **Test connection**. Expect **Connection successful**, then confirm.

<img src="https://mintcdn.com/scitix-adfc65c2/_I6H7WpAVXPiLIwE/model-inference/media/siyuan-add-model.png?fit=max&auto=format&n=_I6H7WpAVXPiLIwE&q=85&s=42c75eaeea8894aef62dca4b4c55651b" alt="SiYuan — Add model with connection test passing" width="2418" height="1360" data-path="model-inference/media/siyuan-add-model.png" />

## Verify

Open the AI chat panel, select `glm-5.2` from the model selector at the bottom, and send a message. A normal reply confirms that the connection works.

<Info>
  The assistant may identify itself as "the SiYuan AI assistant" rather than the underlying model. That is SiYuan's own system prompt, not a routing issue; the model selector still shows the ScitiX model in use.
</Info>

<Warning>
  The AI panel is marked as an early-preview feature in current builds. Back up your data before heavy use.
</Warning>

<img src="https://mintcdn.com/scitix-adfc65c2/_I6H7WpAVXPiLIwE/model-inference/media/siyuan-chat-reply.png?fit=max&auto=format&n=_I6H7WpAVXPiLIwE&q=85&s=0d5c9063f804c52379d5202259a0fd8d" alt="SiYuan — chatting with a ScitiX model" width="2418" height="1360" data-path="model-inference/media/siyuan-chat-reply.png" />

## FAQ

* **Model not responding**: confirm the API Base URL, API Key, and model name. The model must be available over the OpenAI chat-completions protocol, such as `glm-5.2`.
