Some checks failed
ClawSweeper Dispatch / dispatch (push) Has been cancelled
CodeQL / Security High (actions) (push) Has been cancelled
CodeQL / Security High (channel-runtime-boundary) (push) Has been cancelled
CodeQL / Security High (core-auth-secrets) (push) Has been cancelled
CodeQL / Security High (mcp-process-tool-boundary) (push) Has been cancelled
CodeQL / Security High (network-ssrf-boundary) (push) Has been cancelled
CodeQL / Security High (plugin-trust-boundary) (push) Has been cancelled
CodeQL / Security High (process-exec-boundary) (push) Has been cancelled
Docs Sync Publish Repo / sync-publish-repo (push) Has been cancelled
Docs / docs (push) Has been cancelled
OpenClaw Stable Main Closeout / Resolve stable release closeout inputs (push) Has been cancelled
OpenClaw Stable Main Closeout / Verify stable main closeout (push) Has been cancelled
Workflow Sanity / no-tabs (push) Has been cancelled
Workflow Sanity / actionlint (push) Has been cancelled
Workflow Sanity / generated-doc-baselines (push) Has been cancelled
CI / runner-admission (push) Has been cancelled
CI / preflight (push) Has been cancelled
CI / security-fast (push) Has been cancelled
CI / pnpm-store-warmup (push) Has been cancelled
CI / build-artifacts (push) Has been cancelled
CI / native-i18n (push) Has been cancelled
CI / ${{ matrix.check_name }} (push) Has been cancelled
CI / ${{ matrix.checkName }} (push) Has been cancelled
CI / checks-node-compat-node22 (push) Has been cancelled
CI / check-bundled-channel-config-metadata (push) Has been cancelled
CI / check-dependencies (push) Has been cancelled
CI / check-guards (push) Has been cancelled
CI / check-lint (push) Has been cancelled
CI / check-prod-types (push) Has been cancelled
CI / check-shrinkwrap (push) Has been cancelled
CI / check-test-types (push) Has been cancelled
CI / check-additional-boundaries-a (push) Has been cancelled
CI / check-additional-boundaries-bcd (push) Has been cancelled
CI / check-additional-extension-bundled (push) Has been cancelled
CI / check-additional-extension-channels (push) Has been cancelled
CI / check-additional-extension-package-boundary (push) Has been cancelled
CI / check-additional-runtime-topology-architecture (push) Has been cancelled
CI / check-session-accessor-boundary (push) Has been cancelled
CI / check-session-transcript-reader-boundary (push) Has been cancelled
CI / check-docs (push) Has been cancelled
CI / skills-python (push) Has been cancelled
CI / macos-swift (push) Has been cancelled
CI / ios-build (push) Has been cancelled
CI / ci-timings-summary (push) Has been cancelled
Native App Locale Refresh / Refresh native fa (push) Has been cancelled
Native App Locale Refresh / Refresh native fr (push) Has been cancelled
Native App Locale Refresh / Refresh native hi (push) Has been cancelled
Native App Locale Refresh / Refresh native id (push) Has been cancelled
Native App Locale Refresh / Refresh native it (push) Has been cancelled
Native App Locale Refresh / Refresh native ja-JP (push) Has been cancelled
Control UI Locale Refresh / plan (push) Has been cancelled
Control UI Locale Refresh / Refresh ${{ matrix.locale }} (push) Has been cancelled
Control UI Locale Refresh / Commit control UI locale refresh (push) Has been cancelled
Live Media Runner Image / Build live media runner image (push) Has been cancelled
Native App Locale Refresh / Refresh native ar (push) Has been cancelled
Native App Locale Refresh / Refresh native de (push) Has been cancelled
Native App Locale Refresh / Refresh native es (push) Has been cancelled
Native App Locale Refresh / Refresh native ko (push) Has been cancelled
Native App Locale Refresh / Refresh native nl (push) Has been cancelled
Native App Locale Refresh / Refresh native pl (push) Has been cancelled
Native App Locale Refresh / Refresh native pt-BR (push) Has been cancelled
Native App Locale Refresh / Refresh native ru (push) Has been cancelled
Native App Locale Refresh / Refresh native sv (push) Has been cancelled
Native App Locale Refresh / Refresh native th (push) Has been cancelled
Native App Locale Refresh / Refresh native tr (push) Has been cancelled
Native App Locale Refresh / Refresh native uk (push) Has been cancelled
Native App Locale Refresh / Refresh native vi (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-CN (push) Has been cancelled
Native App Locale Refresh / Refresh native zh-TW (push) Has been cancelled
Native App Locale Refresh / Commit native locale refresh (push) Has been cancelled
Plugin Init Scaffold Validation / Validate provider scaffold (push) Has been cancelled
Plugin NPM Release / preview_plugins_npm (push) Has been cancelled
Plugin NPM Release / Validate release publish approval (push) Has been cancelled
Plugin NPM Release / preview_plugin_pack (push) Has been cancelled
Plugin NPM Release / publish_plugins_npm (push) Has been cancelled
Sandbox Common Smoke / sandbox-common-smoke (push) Has been cancelled
Website Installer Sync / static (push) Has been cancelled
Website Installer Sync / linux-docker (push) Has been cancelled
Website Installer Sync / macos-installer (push) Has been cancelled
Website Installer Sync / windows-installer (push) Has been cancelled
Website Installer Sync / sync-website (push) Has been cancelled
Adolf is a fork/vendored clone of github.com/openclaw/openclaw (v2026.6.11), free to diverge. Tree copied sans upstream .git; upstream remote added for future syncs. Node pinned to 24 (.nvmrc); engines already require >=22.19. Preserves docs/ARCHITECTURE.md. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LeqyaxJF2nbRXJtae2kNB2
180 lines
5.5 KiB
Markdown
180 lines
5.5 KiB
Markdown
---
|
|
summary: "Use Vydra image, video, and speech in OpenClaw"
|
|
read_when:
|
|
- You want Vydra media generation in OpenClaw
|
|
- You need Vydra API key setup guidance
|
|
title: "Vydra"
|
|
---
|
|
|
|
The bundled Vydra plugin adds:
|
|
|
|
- Image generation via `vydra/grok-imagine`
|
|
- Video generation via `vydra/veo3` (text-to-video) and `vydra/kling` (image-to-video)
|
|
- Speech synthesis via Vydra's ElevenLabs-backed TTS route
|
|
|
|
OpenClaw uses the same `VYDRA_API_KEY` for all three capabilities.
|
|
|
|
| Property | Value |
|
|
| --------------- | ------------------------------------------------------------------------- |
|
|
| Provider id | `vydra` |
|
|
| Plugin | bundled, `enabledByDefault: true` |
|
|
| Auth env var | `VYDRA_API_KEY` |
|
|
| Onboarding flag | `--auth-choice vydra-api-key` |
|
|
| Direct CLI flag | `--vydra-api-key <key>` |
|
|
| Contracts | `imageGenerationProviders`, `videoGenerationProviders`, `speechProviders` |
|
|
| Base URL | `https://www.vydra.ai/api/v1` (use the `www` host) |
|
|
|
|
<Warning>
|
|
Use `https://www.vydra.ai/api/v1` as the base URL. Vydra's apex host (`https://vydra.ai/api/v1`) currently redirects to `www`. Some HTTP clients drop `Authorization` on that cross-host redirect, which turns a valid API key into a misleading auth failure. The bundled plugin normalizes any configured `vydra.ai` base URL to `www.vydra.ai` to avoid that.
|
|
</Warning>
|
|
|
|
## Setup
|
|
|
|
<Steps>
|
|
<Step title="Run interactive onboarding">
|
|
```bash
|
|
openclaw onboard --auth-choice vydra-api-key
|
|
```
|
|
|
|
Or set the env var directly:
|
|
|
|
```bash
|
|
export VYDRA_API_KEY="vydra_live_..."
|
|
```
|
|
|
|
</Step>
|
|
<Step title="Choose a default capability">
|
|
Pick one or more of the capabilities below (image, video, or speech) and apply the matching configuration.
|
|
</Step>
|
|
</Steps>
|
|
|
|
## Capabilities
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Image generation">
|
|
Default and only bundled image model:
|
|
|
|
- `vydra/grok-imagine`
|
|
|
|
Set it as the default image provider:
|
|
|
|
```json5
|
|
{
|
|
agents: {
|
|
defaults: {
|
|
imageGenerationModel: {
|
|
primary: "vydra/grok-imagine",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
Bundled support is text-to-image only, at most one image per request. Vydra's hosted edit routes expect remote image URLs, and the bundled plugin does not add a Vydra-specific upload bridge.
|
|
|
|
<Note>
|
|
See [Image Generation](/tools/image-generation) for shared tool parameters, provider selection, and failover behavior.
|
|
</Note>
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="Video generation">
|
|
Registered video models:
|
|
|
|
- `vydra/veo3` for text-to-video (rejects image reference inputs)
|
|
- `vydra/kling` for image-to-video (requires exactly one remote image URL)
|
|
|
|
Set Vydra as the default video provider:
|
|
|
|
```json5
|
|
{
|
|
agents: {
|
|
defaults: {
|
|
videoGenerationModel: {
|
|
primary: "vydra/veo3",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
Notes:
|
|
|
|
- `vydra/kling` rejects local file uploads up front; only a remote image URL reference works.
|
|
- Vydra's `kling` HTTP route has been inconsistent about whether it requires `image_url` or `video_url`; the bundled provider sends the same remote image URL in both fields.
|
|
- The bundled plugin stays conservative and does not forward undocumented style knobs such as aspect ratio, resolution, watermark, or generated audio.
|
|
|
|
<Note>
|
|
See [Video Generation](/tools/video-generation) for shared tool parameters, provider selection, and failover behavior.
|
|
</Note>
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="Video live tests">
|
|
Provider-specific live coverage:
|
|
|
|
```bash
|
|
OPENCLAW_LIVE_TEST=1 \
|
|
OPENCLAW_LIVE_VYDRA_VIDEO=1 \
|
|
pnpm test:live -- extensions/vydra/vydra.live.test.ts
|
|
```
|
|
|
|
The bundled Vydra live file covers:
|
|
|
|
- `vydra/veo3` text-to-video
|
|
- `vydra/kling` image-to-video using a remote image URL
|
|
|
|
Override the remote image fixture when needed:
|
|
|
|
```bash
|
|
export OPENCLAW_LIVE_VYDRA_KLING_IMAGE_URL="https://example.com/reference.png"
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
<Accordion title="Speech synthesis">
|
|
Set Vydra as the speech provider:
|
|
|
|
```json5
|
|
{
|
|
messages: {
|
|
tts: {
|
|
provider: "vydra",
|
|
providers: {
|
|
vydra: {
|
|
apiKey: "${VYDRA_API_KEY}",
|
|
voiceId: "21m00Tcm4TlvDq8ikWAM",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
Defaults:
|
|
|
|
- Model: `elevenlabs/tts`
|
|
- Voice id: `21m00Tcm4TlvDq8ikWAM` ("Rachel")
|
|
|
|
The bundled plugin exposes this one known-good default voice and returns MP3 audio files.
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
## Related
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Provider directory" href="/providers/index" icon="list">
|
|
Browse all available providers.
|
|
</Card>
|
|
<Card title="Image generation" href="/tools/image-generation" icon="image">
|
|
Shared image tool parameters and provider selection.
|
|
</Card>
|
|
<Card title="Video generation" href="/tools/video-generation" icon="video">
|
|
Shared video tool parameters and provider selection.
|
|
</Card>
|
|
<Card title="Configuration reference" href="/gateway/config-agents#agent-defaults" icon="gear">
|
|
Agent defaults and model configuration.
|
|
</Card>
|
|
</CardGroup>
|