chore(sync): mirror docs from openclaw/openclaw@379bc1c032
This commit is contained in:
openclaw-docs-sync[bot]
parent
f7182d4142
commit
8b9c5a04b3
@ -1,5 +1,5 @@
|
||||
{
|
||||
"repository": "openclaw/openclaw",
|
||||
"sha": "0e85343b6cc241ed5b843f6385ee158f600d4e44",
|
||||
"syncedAt": "2026-04-05T23:40:59.533Z"
|
||||
"sha": "379bc1c032e924f45ae015de22bb5f01859dd7cb",
|
||||
"syncedAt": "2026-04-05T23:51:12.566Z"
|
||||
}
|
||||
|
||||
@ -77,9 +77,12 @@ openclaw tasks flow cancel <lookup>
|
||||
| Subagent orchestration | `subagent` | Spawning a subagent via `sessions_spawn` | `done_only` |
|
||||
| Cron jobs (all types) | `cron` | Every cron execution (main-session and isolated) | `silent` |
|
||||
| CLI operations | `cli` | `openclaw agent` commands that run through the gateway | `silent` |
|
||||
| Agent media jobs | `cli` | Session-backed `video_generate` runs | `silent` |
|
||||
|
||||
Main-session cron tasks use `silent` notify policy by default — they create records for tracking but do not generate notifications. Isolated cron tasks also default to `silent` but are more visible because they run in their own session.
|
||||
|
||||
Session-backed `video_generate` runs also use `silent` notify policy. They still create task records, but completion is handed back to the original agent session as an internal wake so the agent can write the follow-up message and attach the finished video itself.
|
||||
|
||||
**What does not create tasks:**
|
||||
|
||||
- Heartbeat turns — main-session; see [Heartbeat](/gateway/heartbeat)
|
||||
|
||||
@ -198,6 +198,8 @@ Current bundled examples:
|
||||
media-understanding and video-generation provider registrations for its
|
||||
multimodal surfaces; Qwen video generation uses the Standard DashScope video
|
||||
endpoints with bundled Wan models such as `wan2.6-t2v` and `wan2.7-r2v`
|
||||
- `runway`: plugin-owned video-generation provider registration for native
|
||||
Runway task-based models such as `gen4.5`
|
||||
- `minimax`: plugin-owned catalogs, bundled video-generation provider
|
||||
registration for Hailuo video models, bundled image-generation provider
|
||||
registration for `image-01`, hybrid Anthropic/OpenAI replay-policy
|
||||
|
||||
@ -54,6 +54,7 @@ Looking for chat channel docs (WhatsApp/Telegram/Discord/Slack/Mattermost (plugi
|
||||
- [Perplexity (web search)](/providers/perplexity-provider)
|
||||
- [Qianfan](/providers/qianfan)
|
||||
- [Qwen Cloud](/providers/qwen)
|
||||
- [Runway](/providers/runway)
|
||||
- [SGLang (local models)](/providers/sglang)
|
||||
- [StepFun](/providers/stepfun)
|
||||
- [Synthetic](/providers/synthetic)
|
||||
|
||||
67
docs/providers/runway.md
Normal file
67
docs/providers/runway.md
Normal file
@ -0,0 +1,67 @@
|
||||
---
|
||||
title: "Runway"
|
||||
summary: "Runway video generation setup in OpenClaw"
|
||||
read_when:
|
||||
- You want to use Runway video generation in OpenClaw
|
||||
- You need the Runway API key/env setup
|
||||
- You want to make Runway the default video provider
|
||||
---
|
||||
|
||||
# Runway
|
||||
|
||||
OpenClaw ships a bundled `runway` provider for hosted video generation.
|
||||
|
||||
- Provider: `runway`
|
||||
- Auth: `RUNWAYML_API_SECRET` (canonical; `RUNWAY_API_KEY` also works)
|
||||
- API: Runway task-based video generation API
|
||||
|
||||
## Quick start
|
||||
|
||||
1. Set the API key:
|
||||
|
||||
```bash
|
||||
openclaw onboard --auth-choice runway-api-key
|
||||
```
|
||||
|
||||
2. Set a default video model:
|
||||
|
||||
```json5
|
||||
{
|
||||
agents: {
|
||||
defaults: {
|
||||
videoGenerationModel: {
|
||||
primary: "runway/gen4.5",
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
## Video generation
|
||||
|
||||
The bundled `runway` video-generation provider defaults to `runway/gen4.5`.
|
||||
|
||||
- Modes: text-to-video, single-image image-to-video, and single-video video-to-video
|
||||
- Runtime: async task submit + poll via `GET /v1/tasks/{id}`
|
||||
- Local image/video references: supported via data URIs
|
||||
- Current video-to-video caveat: OpenClaw currently requires `runway/gen4_aleph` for video inputs
|
||||
- Current text-to-video caveat: OpenClaw currently exposes `16:9` and `9:16` for text-only runs
|
||||
|
||||
To use Runway as the default video provider:
|
||||
|
||||
```json5
|
||||
{
|
||||
agents: {
|
||||
defaults: {
|
||||
videoGenerationModel: {
|
||||
primary: "runway/gen4.5",
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
## Related
|
||||
|
||||
- [Video Generation](/tools/video-generation)
|
||||
- [Configuration Reference](/gateway/configuration-reference#agent-defaults)
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
summary: "Generate videos using configured providers such as Alibaba, OpenAI, Google, Qwen, and MiniMax"
|
||||
summary: "Generate videos using configured providers such as Alibaba, OpenAI, Google, Qwen, MiniMax, and Runway"
|
||||
read_when:
|
||||
- Generating videos via the agent
|
||||
- Configuring video generation providers and models
|
||||
@ -9,19 +9,19 @@ title: "Video Generation"
|
||||
|
||||
# Video Generation
|
||||
|
||||
The `video_generate` tool lets the agent create videos using your configured providers. Generated videos are delivered automatically as media attachments in the agent's reply.
|
||||
The `video_generate` tool lets the agent create videos using your configured providers. In agent sessions, OpenClaw starts video generation as a background task, tracks it in the task ledger, then wakes the agent again when the clip is ready so the agent can post the finished video back into the original channel.
|
||||
|
||||
<Note>
|
||||
The tool only appears when at least one video-generation provider is available. If you don't see `video_generate` in your agent's tools, configure `agents.defaults.videoGenerationModel` or set up a provider API key.
|
||||
</Note>
|
||||
|
||||
<Note>
|
||||
OpenClaw now records `video_generate` runs in the task ledger when the agent has a session key, so long-running generations can be tracked with task/run ids even though the tool still waits for completion in the current turn.
|
||||
In agent sessions, `video_generate` returns immediately with a task id/run id. The actual provider job continues in the background. When it finishes, OpenClaw wakes the same session with an internal completion event so the agent can send a normal follow-up plus the generated video attachment.
|
||||
</Note>
|
||||
|
||||
## Quick start
|
||||
|
||||
1. Set an API key for at least one provider (for example `OPENAI_API_KEY`, `GEMINI_API_KEY`, `MODELSTUDIO_API_KEY`, or `QWEN_API_KEY`).
|
||||
1. Set an API key for at least one provider (for example `OPENAI_API_KEY`, `GEMINI_API_KEY`, `MODELSTUDIO_API_KEY`, `QWEN_API_KEY`, or `RUNWAYML_API_SECRET`).
|
||||
2. Optionally set your preferred model:
|
||||
|
||||
```json5
|
||||
@ -40,6 +40,8 @@ OpenClaw now records `video_generate` runs in the task ledger when the agent has
|
||||
|
||||
The agent calls `video_generate` automatically. No tool allow-listing needed — it's enabled by default when a provider is available.
|
||||
|
||||
For direct synchronous contexts without a session-backed agent run, the tool still falls back to inline generation and returns the final media path in the tool result.
|
||||
|
||||
## Supported providers
|
||||
|
||||
| Provider | Default model | Reference inputs | API key |
|
||||
@ -51,6 +53,7 @@ The agent calls `video_generate` automatically. No tool allow-listing needed —
|
||||
| MiniMax | `MiniMax-Hailuo-2.3` | 1 image | `MINIMAX_API_KEY` |
|
||||
| OpenAI | `sora-2` | 1 image or 1 video | `OPENAI_API_KEY` |
|
||||
| Qwen | `wan2.6-t2v` | Yes, remote URLs | `QWEN_API_KEY`, `MODELSTUDIO_API_KEY`, `DASHSCOPE_API_KEY` |
|
||||
| Runway | `gen4.5` | 1 image or 1 video | `RUNWAYML_API_SECRET`, `RUNWAY_API_KEY` |
|
||||
| Together | `Wan-AI/Wan2.2-T2V-A14B` | 1 image | `TOGETHER_API_KEY` |
|
||||
| xAI | `grok-imagine-video` | 1 image or 1 video | `XAI_API_KEY` |
|
||||
|
||||
@ -81,6 +84,13 @@ Use `action: "list"` to inspect available providers and models at runtime:
|
||||
|
||||
Not all providers support all parameters. The tool validates provider capability limits before it submits the request. When a provider or model only supports a discrete set of video lengths, OpenClaw rounds `durationSeconds` to the nearest supported value and reports the normalized duration in the tool result.
|
||||
|
||||
## Async behavior
|
||||
|
||||
- Session-backed agent runs: `video_generate` creates a background task, returns a started/task response immediately, and posts the finished video later in a follow-up agent message.
|
||||
- Task tracking: use `openclaw tasks list` / `openclaw tasks show <taskId>` to inspect queued, running, and terminal status for the generation.
|
||||
- Completion wake: OpenClaw injects an internal completion event back into the same session so the model can write the user-facing follow-up itself.
|
||||
- No-session fallback: direct/local contexts without a real agent session still run inline and return the final video result in the same turn.
|
||||
|
||||
## Configuration
|
||||
|
||||
### Model selection
|
||||
@ -118,6 +128,7 @@ If a provider fails, the next candidate is tried automatically. If all fail, the
|
||||
- MiniMax, Together, BytePlus, and fal currently support a single image reference input.
|
||||
- OpenAI uses the native video endpoint and currently defaults to `sora-2`.
|
||||
- Qwen supports image/video references, but the upstream DashScope video endpoint currently requires remote `http(s)` URLs for those references.
|
||||
- Runway uses the native async task API with `GET /v1/tasks/{id}` polling and currently defaults to `gen4.5`.
|
||||
- xAI uses the native xAI video API and supports text-to-video, image-to-video, and remote video edit/extend flows.
|
||||
- fal uses the queue-backed fal video flow for long-running jobs instead of a single blocking inference request.
|
||||
|
||||
@ -128,11 +139,13 @@ The bundled Qwen provider supports text-to-video plus image/video reference mode
|
||||
## Related
|
||||
|
||||
- [Tools Overview](/tools) — all available agent tools
|
||||
- [Background Tasks](/automation/tasks) — task tracking for detached `video_generate` runs
|
||||
- [Alibaba Model Studio](/providers/alibaba) — direct Wan provider setup
|
||||
- [Google (Gemini)](/providers/google) — Veo provider setup
|
||||
- [MiniMax](/providers/minimax) — Hailuo provider setup
|
||||
- [OpenAI](/providers/openai) — Sora provider setup
|
||||
- [Qwen](/providers/qwen) — Qwen-specific setup and limits
|
||||
- [Runway](/providers/runway) — Runway setup and current model/input notes
|
||||
- [Together AI](/providers/together) — Together Wan provider setup
|
||||
- [xAI](/providers/xai) — Grok video provider setup
|
||||
- [Configuration Reference](/gateway/configuration-reference#agent-defaults) — `videoGenerationModel` config
|
||||
|
||||
Loading…
Reference in New Issue
Block a user