PixVerse Video Generation Provider Setup in OpenClaw
Covers registering the pixverse provider as an official OpenClaw external plugin for PixVerse video generation, including the plugin package, API key auth and CLI flags. For developers configuring video generation in OpenClaw.
Read this when
- You want to use PixVerse video generation in OpenClaw
- You need the PixVerse API key/env setup
- You want to make PixVerse the default video provider
pixverse is offered by OpenClaw as an official external plugin for PixVerse video generation hosted on the platform. Registration of the pixverse provider happens against the videoGenerationProviders contract.
| Property | Value |
|---|---|
| Provider id | pixverse |
| Plugin package | @openclaw/pixverse-provider |
| Auth env var | PIXVERSE_API_KEY |
| Onboarding flag | --auth-choice pixverse-api-key |
| Direct CLI flag | --pixverse-api-key <key> |
| API | PixVerse Platform API v2 (video_id submission plus result polling) |
| Default model | pixverse/v6 |
| Default API region | International |
Getting started
Install the plugin
openclaw plugins install @openclaw/pixverse-provider
When a Gateway is running, installation is applied to it automatically; if not, the change takes effect at the next startup. See Apply changes and inspect.
Set the API key
openclaw onboard --auth-choice pixverse-api-key
Before region and baseUrl are written into the provider config, the wizard asks which endpoint to use, International or CN (see API region below). Runs that are non-interactive (key supplied via --pixverse-api-key or PIXVERSE_API_KEY) fall back to International.
Onboarding additionally assigns agents.defaults.mediaModels.video.primary the value pixverse/v6 if no default video model has been configured yet.
Switch an existing default video provider (optional)
openclaw config set agents.defaults.mediaModels.video.primary "pixverse/v6"
Generate a video
Have the agent generate a video. PixVerse gets selected on its own.
Supported modes and models
PixVerse generation models are made available by the provider through the video tool that OpenClaw shares across providers.
| Mode | Models | Reference input |
|---|---|---|
| Text-to-video | v6 (default), c1 | None |
| Image-to-video | v6 (default), c1 | 1 local or remote image |
Before an image-to-video request is sent, local image references get uploaded to PixVerse. For remote image URLs, the PixVerse image upload endpoint receives them as image_url.
| Option | Supported values |
|---|---|
| Duration | 1-15 seconds (default 5) |
| Resolution | 360P, 540P, 720P, 1080P (default 540P; 480P requests map to 540P) |
| Aspect ratio | 16:9 (default), 4:3, 1:1, 3:4, 9:16, 2:3, 3:2, 21:9; text-to-video only, image-to-video follows the source image |
| Generated audio | audio: true |
Note
image_generatedoes not expose PixVerse image template generation. That API works from template ids, whereas the shared image-generation contract in OpenClaw offers no typed option bag specific to PixVerse.
Provider options
These optional keys, specific to the provider, are accepted by the video provider:
| Option | Type | Effect |
|---|---|---|
seed | number | Seed value for reproducible results, ranging from 0 to 2147483647 |
negativePrompt / negative_prompt | string | Prompt describing what to avoid |
quality | string | Quality level for PixVerse, for example 720p |
motionMode / motion_mode | string | Motion mode for image-to-video (defaults to normal) |
cameraMovement / camera_movement | string | Preset for PixVerse camera movement |
templateId / template_id | number | ID of the PixVerse template to activate |
Configuration
{
agents: {
defaults: {
mediaModels: {
video: {
primary: "pixverse/v6",
},
},
},
},
}
Advanced configuration
API region
| Region value | PixVerse API base URL |
|---|---|
international | https://app-api.pixverse.ai/openapi/v2 |
cn | https://app-api.pixverseai.cn/openapi/v2 |
When your key is tied to a particular PixVerse platform region, assign models.providers.pixverse.region yourself. Alternatively, pick a region inside the setup wizard by running openclaw onboard --auth-choice pixverse-api-key:
{
models: {
providers: {
pixverse: {
region: "cn", // "international" or "cn"
baseUrl: "https://app-api.pixverseai.cn/openapi/v2",
models: [],
},
},
},
}
Custom base URL
Assign models.providers.pixverse.baseUrl only if traffic passes through a compatible proxy you trust. Priority goes to baseUrl over region.
{
models: {
providers: {
pixverse: {
baseUrl: "https://app-api.pixverse.ai/openapi/v2",
},
},
},
}
Task polling
A video_id comes back from PixVerse when you submit the generation request. OpenClaw then polls /openapi/v2/video/result/{video_id} at 5-second intervals until the task succeeds, fails, or reaches the timeout (5 minutes by default; change it with agents.defaults.mediaModels.video.timeoutMs).
Related
-
Video generation, Parameters shared across tools, how the provider is selected, and async behavior.
-
Configuration reference, Default agent settings, including the video generation model.