docs: adopt co-located documentation structure across modules

This commit is contained in:
openclaw committed 2026-10-19 01:46:55 +00:00
1 parent bd9eda19c1
commit 93ae5b7342
3 files changed
+112 -84

No files matched your search

+66
View File
@@ -0,0 +1,66 @@
# OpenAI Video Provider (`openai-video`)
OpenClaw 视频生成驱动模块,适配标准 **OpenAI Videos API**(`/v1/videos` 规范)。
专为自建聚合网关或第三方中转(如 `gemini-web2api-go`、`ccLoad`)做了深度兼容修复:
* **任务创建**:`POST /v1/videos`。纯文本任务自动发送 JSON Body,避免第三方服务因不支持 Multipart 表单报 400 错误;带参考图/垫视频时使用标准 Multipart 表单。
* **状态轮询**:`GET /v1/videos/{id}`。兼容提取普通对象错误信息与字符串错误消息。
* **视频下载**:`GET /v1/videos/{id}/content`。流式下载 MP4 二进制视频流。
* **私有网络**:原生支持私有/内网端点请求(`allowPrivateNetwork: true`),兼容 `host.incus.internal`、Tailnet 或局域网反代地址。
---
## 配置说明
支持通过 **Web 控制台(Control UI)** 或直接编辑 `~/.openclaw/openclaw.json`。
### 方式 1:Web 控制台可视化配置
进入 **Settings → Plugins → Tools**:
* **API Base URL**:填写视频上游端点(例如 `http://host.incus.internal:8083/v1` 或内部网关地址)
* **API Key**:填写 API Key 或 SecretRef(留空时自动回退读取环境变量 `OPENAI_VIDEO_API_KEY`、`CCLOAD_API_KEY` 或 `BIFROST_API_KEY`)
* **默认视频模型**:例如 `gemini-video` 或 `sora-2`
### 方式 2:编辑 `openclaw.json`
在 `~/.openclaw/openclaw.json` 中配置:
```json5
{
"plugins": {
"entries": {
"tools": {
"enabled": true,
"config": {
"video": {
"baseUrl": "http://host.incus.internal:8083/v1",
"apiKey": "sk-your-video-key",
"defaultModel": "gemini-video",
"allowPrivateNetwork": true
}
}
}
}
},
"agents": {
"defaults": {
"mediaModels": {
"video": {
"primary": "openai-video/gemini-video"
}
}
}
}
}
```
> **向下兼容提示**:插件仍完全兼容旧版独立插件 `plugins.entries["openai-video"].config` 的配置路径,迁移期间无需强行改动旧配置即可直接读取。
---
## 使用方法
配置完成后,OpenClaw 内置的 `video_generate` 工具即可自动调度:
* **自然语言直接对话生成**:
> “帮我生成一个 5 秒的猫咪在海滩上奔跑的 16:9 视频”
* **垫图/图生视频**:
在对话中上传或提供图片链接,提示助手基于该图生成视频。