OpenClaw

Use the Indream OpenClaw plugin for video workflow authoring, asset uploads, project sync, and exports.

Use the Indream OpenClaw plugin when you want an agent to create videos with Indream tools inside an OpenClaw session.

Install

openclaw plugins install @indreamai/openclaw-plugin
openclaw gateway restart

Use OpenClaw gateway 2026.4.2 or later.

Configure

Plugin configuration lives under plugins.entries.indream.config.

{
  plugins: {
    entries: {
      indream: {
        enabled: true,
        config: {
          apiKey: "indream_xxx",
          baseURL: "https://api.indream.ai",
          timeoutMs: 60000,
          pollIntervalMs: 2000,
          uploads: {
            allowLocalPaths: true,
            allowRemoteUrls: true,
          },
        },
      },
    },
  },
}
  • The plugin can be installed with an empty config object, but every live API request requires plugins.entries.indream.config.apiKey.
  • uploads.allowLocalPaths and uploads.allowRemoteUrls control what indream_assets_upload may read.

Available Tools

These tools are available as soon as the plugin is enabled:

  • indream_editor_capabilities
  • indream_illustrations_search
  • indream_assets_get
  • indream_asset_analyze
  • indream_video_workflow_init
  • indream_video_workflow_set_design
  • indream_video_workflow_set_script
  • indream_video_workflow_set_storyboard
  • indream_video_workflow_revise
  • indream_video_workflow_review
  • indream_video_workflow_gate_advance
  • indream_video_workflow_scene_submit
  • indream_video_workflow_scene_list
  • indream_video_workflow_build
  • indream_video_workflow_block_list
  • indream_video_workflow_block_read
  • indream_video_workflow_snapshot
  • indream_video_workflow_commit
  • indream_exports_get
  • indream_exports_download

These write tools are optional because they upload files, save projects, or create export tasks:

  • indream_assets_upload
  • indream_video_projects_create
  • indream_video_projects_sync
  • indream_video_exports_create

Allow all optional tools from this plugin:

{
  tools: {
    allow: ["indream"],
  },
}

Or allow only the write tools you want:

{
  tools: {
    allow: [
      "indream_assets_upload",
      "indream_video_projects_create",
      "indream_video_projects_sync",
      "indream_video_exports_create"
    ],
  },
}

Default Workflow

Use this staged flow:

  1. Start with indream_video_workflow_init.
  2. Add the design brief with indream_video_workflow_set_design.
  3. Add the approved narration or copy with indream_video_workflow_set_script.
  4. Define the scene plan with indream_video_workflow_set_storyboard.
  5. Submit each scene draft with indream_video_workflow_scene_submit.
  6. Run indream_video_workflow_build after every scene is submitted.
  7. Run indream_video_workflow_review, then fix blocking diagnostics with indream_video_workflow_revise.
  8. Use indream_video_workflow_snapshot when preview frames are available for your environment.
  9. Run indream_video_workflow_commit.
  10. Use the returned compiled artifact ID with indream_video_projects_create, indream_video_projects_sync, or indream_video_exports_create.
  11. Track export progress with indream_exports_get, or wait for a terminal result with indream_exports_download.

Asset and Illustration Binding

  • indream_assets_upload accepts either a local file path or a remote HTTP/HTTPS URL.
  • Upload responses include a reusable binding value for later workflow steps and may include image analysis fields.
  • indream_assets_get returns the stored asset record and any available analysis for that assetId.
  • indream_illustrations_search returns supported built-in illustrationName values. Use the returned name directly inside scene sparse JSON.

Example illustration clip for indream_video_workflow_scene_submit:

{
  "id": "s01-illus",
  "type": "illustration",
  "startMs": 0,
  "durationMs": 3000,
  "asset": { "type": "illustration", "illustrationName": "IAiChat" },
  "illustrationColor": "#ff6600",
  "size": { "width": 0.28, "height": 0.28 },
  "position": { "x": 0.62, "y": 0.2 }
}

Bundled Skills

The plugin ships with one public skill:

  • indream-video-workflow

Example prompts:

Use indream-video-workflow to create a 30-second product teaser, upload three local images, build five scenes, review blocking diagnostics, commit the artifact, create a project, and export MP4.

Troubleshooting

  • Missing credentials: requests fail until plugins.entries.indream.config.apiKey is set.
  • Optional tools disabled: if an agent can read but cannot upload, create, sync, or export, add the plugin ID or the exact write tool names to tools.allow.
  • OPEN_API_RUNTIME_ACCESS_FORBIDDEN: the key is valid, but the target resource is outside the current API key's runtime scope.
  • Build prerequisites: indream_video_workflow_build requires every storyboard scene to be submitted first.
  • Compiled artifact required: indream_video_projects_create, indream_video_projects_sync, and indream_video_exports_create require the compiled artifact ID returned by indream_video_workflow_commit.
  • Snapshot unavailable: indream_video_workflow_snapshot may be unavailable in some environments until preview-frame support is enabled.
  • Workflow diagnostics: fix blocking review errors before commit, then retry the project or export step.

Resources

For source code, issues, and contributions, check out the GitHub repository. Install directly from @indreamai/openclaw-plugin to get the latest published package.

Last updated on

On this page