@editframe/api 是 Editframe 云视频 API 的 JavaScript/TypeScript 客户端。主要能力:创建渲染(createRender、getRenderProgress、downloadRender),上传并处理媒体文件(统一 createFile/uploadFile,video、image、caption 共用一套端点),通过 lookupFileByMd5 查重,用 expires_at 控制留存(ISO 8601、最长 30 天,省略为永久)。渲染支持 mp4、jpeg、png、webp 输出,以及 work_slice_ms、duration_ms、metadata 等选项。转写改为在 Pipeline 的 transcribe 步骤中进行,旧 transcribeFile 等端点返回 410 transcription_retired。浏览器直接播放托管媒体时用 URL Signing:服务端持 API key 并调用 createURLToken,前端在 ef-configuration 上设置 signing-url,令牌约一小时有效。
使用方式:服务端用 new Client(process.env.EDITFRAME_API_KEY),API key 形如 ef_<secret>_<keyid>;不要把 API key 暴露在客户端代码中。上传时 createFile 后消费 uploadFile 迭代器,或用 @editframe/api/node 的 upload 辅助函数;上传完成与媒体处理完成是两个独立状态。可用 file-id 把已处理文件放进组合中。
editframe CLI 是已安装本地运行时的薄客户端,需先从 editframe.com/agent 安装运行时,用 npm install -D @editframe/cli。每个本地命令需 --project 与 bridge(--bridge、--component、EDITFRAME_BRIDGE_PATH 或 EDITFRAME_COMPONENT_ROOT)。常用命令如 npx editframe start/open/compositions/context/export/job;本地导出时需保持浏览器编辑器打开,编辑器即渲染器,CLI 只提交与查看任务,不写出视频文件。旧的 preview、dev、render、auth 等命令会以 CLI_MIGRATION_REQUIRED 失败。Pipelines 可按组织启用,未启用时相关路由返回 404;其导入入口 @editframe/api/pipelines 为实验性。其他细节如具体错误码、限制或收费暂未提供。