接入

幕间 OpenAPI 支持开发者以 OpenAI 标准 API 协议接入幕间的在线 LLM 能力。并计划在未来支持更多其他能力。

快速开始

浏览器（UMD）

1. 在已有的 HTML 中引入 SDK

<script
  src="https://cdn.jsdmirror.com/npm/@mujian/js-sdk@latest/dist/umd/lite.js"
  type="text/javascript"
></script>

请将 <script> 标签放在 <head> 的靠前位置，确保在执行任何依赖 $mujian_lite 的代码前完成加载和挂载。

2. 初始化并获取 API 配置

window.$mujian_lite
  .init()
  .then(() => {
    // 初始化成功，可安全访问 openapi 配置
    console.log('API Base URL:', window.$mujian_lite.openapi.baseURL);
    console.log('API Key:', window.$mujian_lite.openapi.apiKey);
  })
  .catch((err) => {
    console.error('SDK 初始化失败:', err);
  });

⚠️ init() 是幂等的：可以多次调用。

NPM 包（适用于 React、Vue 等前端开发框架）

1. 添加SDK到项目中

安装 npm 包：

npm install @mujian/js-sdk

2. 初始化并获取 API 配置

在 JavaScript 文件中导入：

import '@mujian/js-sdk/lite';

window.$mujian_lite.init().then(() => {
  // 初始化成功，可安全访问 openapi 配置
  console.log('API Base URL:', window.$mujian_lite.openapi.baseURL);
  console.log('API Key:', window.$mujian_lite.openapi.apiKey);
}).catch((err) => {
  console.error('SDK 初始化失败:', err);
});

可用属性与方法

名称类型说明
init()Promise<void>初始化SDK，获取配置；必须先调用。
openapi{ baseURL: string; apiKey: string } | undefined初始化成功后可用，包含服务端下发的 API 地址与当前登录用户专属密钥。

window.$mujian_lite 是全局单例，由 SDK 自动挂载，无需手动 new 或 getInstance()。

注意事项

  • openapi 对象在 init() 完成前为 undefined，请勿提前访问。
  • 幕间 OpenAPI 仅支持创作者在本地调试或者上传到幕间提供给其他幕间用户使用。不支持上传到第三方平台的作品进行访问