For AI agents: the complete documentation index is available at https://docs.reelway.ai/llms.txt, the full documentation bundle is available at https://docs.reelway.ai/llms-full.txt, and this page is available as Markdown at https://docs.reelway.ai/sdk/index.md.

title: Reelway SDK description: @reelway/client —— JavaScript / TypeScript 客户端:安装、鉴权与能力面。

Reelway SDK

@reelway/client 是平台的官方客户端,由官方 Sogni SDK(@sogni-ai/sogni-client)fork 而来,接口契约与上游一致,默认对接 reelway 平台(REST https://rcn.reelway.ai,WebSocket wss://rcn.reelway.ai/socket),无需任何端点配置。

安装

包未发布到 npm(构建产物不入库):

git clone git@git.ensurebit.net:reelway/reelway-client-ts.git && cd reelway-client-ts
npm install && npm run build
npm pack    # 生成 reelway-client-<版本>.tgz,业务仓以 npm install <tgz 路径> 引用

初始化与鉴权

import { SogniClient } from '@reelway/client';

const client = await SogniClient.createInstance({
  appId: 'my-app',      // 每个客户端实例唯一;同账号同 appId 的新连接会接管旧连接
  network: 'fast',      // fast | relaxed
  apiKey: process.env.REELWAY_API_KEY,   // 或 username/password 账号登录
});

鉴权二选一:API Key(推荐,控制台随时创建与复制)或 SDK 账户的用户名/密码。Key 由 SDK 代为放入 REST 请求头与 WebSocket 握手头。

能力面

域入口
图像/视频/语音生成client.projects.create() + 事件(progress/completed/failed)
资产上传client.projects.assets.upload(file, contentType, name)
费用预估client.projects.estimateVideoCost()
对话与工具client.chat.*(契约同上游)
项目恢复重连后自动 projects/sync

各域的端点级细节见 API 参考;快速配方见生成配方。