Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.
Python agent-contextagent-memoryagent-pluginsagentic-ragcontext-databasedsh-pluginknowledge-basememorymemory-managementself-evolvingvector-database
docs: use connect agent template tokens (#4152)
ManAsWind42d37996cfdd
diff --git a/docs/images/agents/en/agent-cli.md b/docs/images/agents/en/agent-cli.mdindex 78c3a600c..adeb49ce3 100644--- a/docs/images/agents/en/agent-cli.md+++ b/docs/images/agents/en/agent-cli.md@@ -5,7 +5,7 @@ First ask the user for the OpenViking API Key and store it as OPENVIKING_API_KEYWrite the following content to ~/.openviking/ovcli.conf, replacing ${OPENVIKING_API_KEY} with the actual value provided by the user:{- "url": "https://api.vikingdb.cn-beijing.volces.com/openviking",+ "url": "{{OPENVIKING_BASE_URL}}","api_key": "${OPENVIKING_API_KEY}"}diff --git a/docs/images/agents/en/api.md b/docs/images/agents/en/api.mdindex f06248348..87af806f1 100644--- a/docs/images/agents/en/api.md+++ b/docs/images/agents/en/api.md@@ -8,8 +8,8 @@ from pathlib import Pathimport requests-url = "https://api.vikingdb.cn-beijing.volces.com/openviking"-api_key = "[TODO]your-api-key"+url = "{{OPENVIKING_BASE_URL}}"+api_key = "{{OPENVIKING_API_KEY}}"file_path = Path("[TODO]your-file-path") # e.g. test.txtresource_to = "[TODO]your-resource-path" # e.g. viking://resources/test.txtreason = "[TODO]your-reason" # e.g. External API documentationdiff --git a/docs/images/agents/en/cli.md b/docs/images/agents/en/cli.mdindex 3456af220..51a4e5b59 100644--- a/docs/images/agents/en/cli.md+++ b/docs/images/agents/en/cli.md@@ -10,11 +10,13 @@ npm i -g @openviking/cli && ov config- Base URL: Copy the following Base URL into your terminal```text-https://api.vikingdb.cn-beijing.volces.com/openviking+{{OPENVIKING_BASE_URL}}```- API Key: Copy the API Key shown on the page into your terminal+{{OPENVIKING_API_KEY_BLOCK}}+### Step 3: After configuration, run the following command to view CLI usage:```bashdiff --git a/docs/images/agents/en/cursor.md b/docs/images/agents/en/cursor.mdindex 69693b611..467dce037 100644--- a/docs/images/agents/en/cursor.md+++ b/docs/images/agents/en/cursor.md@@ -6,6 +6,10 @@ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-sharSelect **Volcengine OpenViking Cloud**. Paste the API key from this page.+API Key: Copy the API Key shown on the page and paste it when the installer prompts for it.++{{OPENVIKING_API_KEY_BLOCK}}+## Verify1. Restart Cursor and start a new Agent session.diff --git a/docs/images/agents/en/deerflow-mcp.md b/docs/images/agents/en/deerflow-mcp.mdindex 8934ad78c..1f6eb2ddd 100644--- a/docs/images/agents/en/deerflow-mcp.md+++ b/docs/images/agents/en/deerflow-mcp.md@@ -5,7 +5,7 @@ DeerFlow can connect to OpenViking through an MCP Server. MCP integration lets DEdit the `.env` file in the DeerFlow project root and add the API key from this page:```bash-OPENVIKING_API_KEY=[TODO]your-api-key+OPENVIKING_API_KEY={{OPENVIKING_API_KEY}}```## Step 2: Create an MCP configuration file@@ -26,7 +26,7 @@ Open `extensions_config.json` in the project root and add OpenViking under `mcpS"openviking": {"enabled": true,"type": "http",- "url": "https://api.vikingdb.cn-beijing.volces.com/openviking/mcp",+ "url": "{{OPENVIKING_BASE_URL}}/mcp","headers": {"X-API-Key": "$OPENVIKING_API_KEY"}diff --git a/docs/images/agents/en/deerflow-memory-manager.md b/docs/images/agents/en/deerflow-memory-manager.mdindex b1146242e..d0c0e828a 100644--- a/docs/images/agents/en/deerflow-memory-manager.md+++ b/docs/images/agents/en/deerflow-memory-manager.md@@ -5,7 +5,7 @@ DeerFlow can use OpenViking as a long-term memory backend through MemoryManager.Edit the `.env` file in the DeerFlow project root and add the API key from this page:```bash-OPENVIKING_API_KEY=[TODO]your-api-key+OPENVIKING_API_KEY={{OPENVIKING_API_KEY}}```## Step 2: Update DeerFlow memory configuration@@ -20,7 +20,7 @@ memory:manager_class: openvikingmode: middlewarebackend_config:- base_url: https://api.vikingdb.cn-beijing.volces.com/openviking+ base_url: {{OPENVIKING_BASE_URL}}owner_user_id: defaultapi_key_env: OPENVIKING_API_KEYstartup_policy: fail_fast@@ -57,7 +57,7 @@ Successful log examples:```textMemory manager resolved: OpenVikingMemoryManager (manager_class='openviking')-HTTP Request: GET https://api.vikingdb.cn-beijing.volces.com/openviking/health "HTTP/1.1 200 OK"+HTTP Request: GET {{OPENVIKING_BASE_URL}}/health "HTTP/1.1 200 OK"```## Step 5: Verify memory write and recalldiff --git a/docs/images/agents/en/hermes.md b/docs/images/agents/en/hermes.mdindex 35de74687..f144ddcbf 100644--- a/docs/images/agents/en/hermes.md+++ b/docs/images/agents/en/hermes.md@@ -4,7 +4,9 @@hermes memory setup openviking```-Keep **OpenViking Service (VolcEngine Cloud)**. Paste the API key from this page.+Keep **OpenViking Service (VolcEngine Cloud)**. Paste the API key from this page:++{{OPENVIKING_API_KEY_BLOCK}}## Verifydiff --git a/docs/images/agents/en/mcp.md b/docs/images/agents/en/mcp.mdindex d7a992c16..62965995f 100644--- a/docs/images/agents/en/mcp.md+++ b/docs/images/agents/en/mcp.md@@ -4,9 +4,9 @@{"mcpServers": {"ov-mcp-server": {- "url": "https://api.vikingdb.cn-beijing.volces.com/openviking/mcp",+ "url": "{{OPENVIKING_BASE_URL}}/mcp","headers": {- "Authorization": "Bearer ZGVmYXV********YzdlZjhiMg"+ "Authorization": "Bearer {{OPENVIKING_API_KEY}}"}}}diff --git a/docs/images/agents/en/openclaw.md b/docs/images/agents/en/openclaw.mdindex 5783b57ff..d4d0f79fb 100644--- a/docs/images/agents/en/openclaw.md+++ b/docs/images/agents/en/openclaw.md@@ -1,8 +1,12 @@## Install+Copy the API key from this page:++{{OPENVIKING_API_KEY_BLOCK}}+```bashopenclaw plugins install clawhub:@openviking/openclaw-plugin-openclaw openviking setup --base-url https://api.vikingdb.cn-beijing.volces.com/openviking --api-key <API-key-from-this-page>+openclaw openviking setup --base-url {{OPENVIKING_BASE_URL}} --api-key <API-key-from-this-page>openclaw gateway restart```diff --git a/docs/images/agents/en/sdk.md b/docs/images/agents/en/sdk.mdindex 6bedd2d56..213286120 100644--- a/docs/images/agents/en/sdk.md+++ b/docs/images/agents/en/sdk.md@@ -13,8 +13,8 @@ Refer to the standard write example from GitHub and fill in the API Key and doma```pythonfrom openviking.client import SyncHTTPClient-url = "https://api.vikingdb.cn-beijing.volces.com/openviking"-api_key = "[TODO]your-api-key"+url = "{{OPENVIKING_BASE_URL}}"+api_key = "{{OPENVIKING_API_KEY}}"client = SyncHTTPClient(url=url,diff --git a/docs/images/agents/en/trae.md b/docs/images/agents/en/trae.mdindex ea0e0db77..42740ce2c 100644--- a/docs/images/agents/en/trae.md+++ b/docs/images/agents/en/trae.md@@ -10,6 +10,10 @@ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-sharSelect **Volcengine OpenViking Cloud**. Paste the API key from this page.+API Key: Copy the API Key shown on the page and paste it when the installer prompts for it.++{{OPENVIKING_API_KEY_BLOCK}}+## VerifyRestart TRAE. Confirm `openviking` is connected in settings.diff --git a/docs/images/agents/zh/agent-cli.md b/docs/images/agents/zh/agent-cli.mdindex b7bda1d8c..644dd8a15 100644--- a/docs/images/agents/zh/agent-cli.md+++ b/docs/images/agents/zh/agent-cli.md@@ -6,7 +6,7 @@请在 ~/.openviking/ovcli.conf 写入以下内容:{- "url": "https://api.vikingdb.cn-beijing.volces.com/openviking",+ "url": "{{OPENVIKING_BASE_URL}}","api_key": "${OPENVIKING_API_KEY}"}diff --git a/docs/images/agents/zh/api.md b/docs/images/agents/zh/api.mdindex 692cc1ad0..5a7af4cc4 100644--- a/docs/images/agents/zh/api.md+++ b/docs/images/agents/zh/api.md@@ -8,8 +8,8 @@ from pathlib import Pathimport requests-url = "https://api.vikingdb.cn-beijing.volces.com/openviking"-api_key = "[TODO]your-api-key"+url = "{{OPENVIKING_BASE_URL}}"+api_key = "{{OPENVIKING_API_KEY}}"file_path = Path("[TODO]your-file-path") # e.g. test.txtresource_to = "[TODO]your-resource-path" # e.g. viking://resources/test.txtreason = "[TODO]your-reason" # e.g. External API documentationdiff --git a/docs/images/agents/zh/cli.md b/docs/images/agents/zh/cli.mdindex 244a30455..e40958de5 100644--- a/docs/images/agents/zh/cli.md+++ b/docs/images/agents/zh/cli.md@@ -12,10 +12,12 @@ npm i -g @openviking/cli && ov config- Base URL: 复制以下 Base URL 到你的终端```text-https://api.vikingdb.cn-beijing.volces.com/openviking+{{OPENVIKING_BASE_URL}}```- API Key: 把本页展示的 API Key 粘贴到终端+{{OPENVIKING_API_KEY_BLOCK}}+### 步骤3:配置完成后,可运行以下命令查看 CLI 用法:diff --git a/docs/images/agents/zh/cursor.md b/docs/images/agents/zh/cursor.mdindex ddf928519..41ebc783d 100644--- a/docs/images/agents/zh/cursor.md+++ b/docs/images/agents/zh/cursor.md@@ -6,6 +6,10 @@ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shar选 **火山引擎 OpenViking 云服务**,把本页 API Key 贴进去。+API Key:复制页面中展示的 API Key,并在安装器提示时粘贴。++{{OPENVIKING_API_KEY_BLOCK}}+## 验证1. 重启 Cursor,新建 Agent 会话。diff --git a/docs/images/agents/zh/deerflow-mcp.md b/docs/images/agents/zh/deerflow-mcp.mdindex e5c7633b7..607568006 100644--- a/docs/images/agents/zh/deerflow-mcp.md+++ b/docs/images/agents/zh/deerflow-mcp.md@@ -5,7 +5,7 @@ DeerFlow 支持通过 MCP Server 接入 OpenViking。MCP 接入的核心价值在 DeerFlow 项目根目录下编辑 `.env` 文件,把本页的 API Key 填进去:```bash-OPENVIKING_API_KEY=[TODO]your-api-key+OPENVIKING_API_KEY={{OPENVIKING_API_KEY}}```## 步骤 2:创建 MCP 配置文件@@ -26,7 +26,7 @@ cp extensions_config.example.json extensions_config.json"openviking": {"enabled": true,"type": "http",- "url": "https://api.vikingdb.cn-beijing.volces.com/openviking/mcp",+ "url": "{{OPENVIKING_BASE_URL}}/mcp","headers": {"X-API-Key": "$OPENVIKING_API_KEY"}diff --git a/docs/images/agents/zh/deerflow-memory-manager.md b/docs/images/agents/zh/deerflow-memory-manager.mdindex ae954623d..1df5f52cc 100644--- a/docs/images/agents/zh/deerflow-memory-manager.md+++ b/docs/images/agents/zh/deerflow-memory-manager.md@@ -5,7 +5,7 @@ DeerFlow 支持通过 MemoryManager 接入 OpenViking 作为长期记忆后端在 DeerFlow 项目根目录下编辑 `.env` 文件,把本页的 API Key 填进去:```bash-OPENVIKING_API_KEY=[TODO]your-api-key+OPENVIKING_API_KEY={{OPENVIKING_API_KEY}}```## 步骤 2:修改 DeerFlow 的 memory 配置@@ -20,7 +20,7 @@ memory:manager_class: openvikingmode: middlewarebackend_config:- base_url: https://api.vikingdb.cn-beijing.volces.com/openviking+ base_url: {{OPENVIKING_BASE_URL}}owner_user_id: defaultapi_key_env: OPENVIKING_API_KEYstartup_policy: fail_fast@@ -57,7 +57,7 @@ grep -i "memory manager resolved\|openviking\|deermem" logs/gateway.log```textMemory manager resolved: OpenVikingMemoryManager (manager_class='openviking')-HTTP Request: GET https://api.vikingdb.cn-beijing.volces.com/openviking/health "HTTP/1.1 200 OK"+HTTP Request: GET {{OPENVIKING_BASE_URL}}/health "HTTP/1.1 200 OK"```## 步骤 5:验证写入与召回diff --git a/docs/images/agents/zh/hermes.md b/docs/images/agents/zh/hermes.mdindex 08a2e141a..07df95bf9 100644--- a/docs/images/agents/zh/hermes.md+++ b/docs/images/agents/zh/hermes.md@@ -4,7 +4,9 @@hermes memory setup openviking```-保持 **OpenViking Service (VolcEngine Cloud)**,把本页 API Key 贴进去。+保持 **OpenViking Service (VolcEngine Cloud)**,把本页 API Key 贴进去:++{{OPENVIKING_API_KEY_BLOCK}}## 验证diff --git a/docs/images/agents/zh/mcp.md b/docs/images/agents/zh/mcp.mdindex 03d762aea..86c47fa8b 100644--- a/docs/images/agents/zh/mcp.md+++ b/docs/images/agents/zh/mcp.md@@ -4,9 +4,9 @@{"mcpServers": {"ov-mcp-server": {- "url": "https://api.vikingdb.cn-beijing.volces.com/openviking/mcp",+ "url": "{{OPENVIKING_BASE_URL}}/mcp","headers": {- "Authorization": "Bearer ZGVmYXV********YzdlZjhiMg"+ "Authorization": "Bearer {{OPENVIKING_API_KEY}}"}}}diff --git a/docs/images/agents/zh/openclaw.md b/docs/images/agents/zh/openclaw.mdindex 913c42d9b..ff0813848 100644--- a/docs/images/agents/zh/openclaw.md+++ b/docs/images/agents/zh/openclaw.md@@ -1,8 +1,12 @@## 安装+复制本页 API Key:++{{OPENVIKING_API_KEY_BLOCK}}+```bashopenclaw plugins install clawhub:@openviking/openclaw-plugin-openclaw openviking setup --base-url https://api.vikingdb.cn-beijing.volces.com/openviking --api-key <本页的-API-Key>+openclaw openviking setup --base-url {{OPENVIKING_BASE_URL}} --api-key <本页的-API-Key>openclaw gateway restart```diff --git a/docs/images/agents/zh/sdk.md b/docs/images/agents/zh/sdk.mdindex 9ab756d6a..1da7bb700 100644--- a/docs/images/agents/zh/sdk.md+++ b/docs/images/agents/zh/sdk.md@@ -11,8 +11,8 @@ pip install openviking --upgrade --force-reinstall```pythonfrom openviking.client import SyncHTTPClient-url = "https://api.vikingdb.cn-beijing.volces.com/openviking"-api_key = "[TODO]your-api-key"+url = "{{OPENVIKING_BASE_URL}}"+api_key = "{{OPENVIKING_API_KEY}}"client = SyncHTTPClient(url=url,diff --git a/docs/images/agents/zh/trae.md b/docs/images/agents/zh/trae.mdindex 96e4a0ee9..eee2695e6 100644--- a/docs/images/agents/zh/trae.md+++ b/docs/images/agents/zh/trae.md@@ -10,6 +10,10 @@ bash <(curl -fsSL https://ovrelease.tos-cn-beijing.volces.com/memory-plugin-shar选 **火山引擎 OpenViking 云服务**,把本页 API Key 贴进去。+API Key:复制页面中展示的 API Key,并在安装器提示时粘贴。++{{OPENVIKING_API_KEY_BLOCK}}+## 验证重启 TRAE。在设置里确认 `openviking` 已连接。