Dlazy Plan

dlazy-plan

English · 中文

Idea-to-video planning tool for CLI / external agents. Drives Agent and returns both a logical plan template (with map / when control flow) and an expanded flat shape list ready to drop onto the canvas via drawToCanvas.

Trigger Keywords

Authentication

All requests require a dLazy API key. The recommended way to authenticate is:

dlazy login

This runs a device-code flow (also works in remote shells) and automatically saves your API key to the local CLI config — no manual copy/paste required.

Alternative: Set the Key Manually

If you already have an API key, you can save it directly:

dlazy auth set YOUR_API_KEY

The CLI saves the key in your user config directory (~/.dlazy/config.json on macOS/Linux, %USERPROFILE%\.dlazy\config.json on Windows), with file permissions restricted to your OS user account. You can also supply the key per-invocation via the DLAZY_API_KEY environment variable.

Getting Your API Key Manually

1. Sign in or create an account at dlazy.com 2. Go to dlazy.com/dashboard/organization/api-key 3. Copy the key shown in the API Key section

Each key is scoped to your dLazy organization and can be rotated or revoked at any time from the same dashboard.

About & Provenance

You can install on demand without persisting a global binary by running:

npx @dlazy/cli@1.0.9 

Or, if you prefer a global install, the skill's metadata.clawdbot.install field declares the exact pinned version (npm install -g @dlazy/cli@1.0.9). Review the GitHub source before installing.

How It Works

This skill is a thin client over the dLazy hosted API. When you invoke it:

This is the standard SaaS pattern; the skill itself does not access network or filesystem resources beyond what the dLazy CLI already handles. See dlazy.com for the full service terms.

Usage

CRITICAL INSTRUCTION FOR AGENT: Execute dlazy plan to get the result.

dlazy plan -h
Options:
  --prompt [prompt]                    Free-form instruction describing the video to plan (idea + optional requirements / scale).
  --scenario [scenario]                Planning scenario controlling output structure. One of: general (default, auto) / idea2video / single_image / character_design / storyboard / product_showcase / short_video / music_video / tutorial. [default: general] (choices: "general", "idea2video", "single_image", "character_design", "storyboard", "product_showcase", "short_video", "music_video", "tutorial")
  --style [style]                      Visual style enum. One of: general (default, no bias) / cinematic / anime / pixar_3d / ghibli / watercolor / cyberpunk / vintage_film / documentary / minimalist / cartoon_2d. [default: general] (choices: "general", "cinematic", "anime", "pixar_3d", "ghibli", "watercolor", "cyberpunk", "vintage_film", "documentary", "minimalist", "cartoon_2d")
  --sessionId [sessionId]              Resume an existing Agent session id (recommended for cache hits and context continuity); leave empty to start a new session.
  --dry-run                            Print payload + cost estimate without calling API
  --no-wait                            Return generateId immediately for async tasks
  --timeout                   Max seconds to wait for async completion (default: "1800")
  -h, --help                           display help for command

> Any flag also accepts pipe references — - (auto-pick from upstream stdin), @N (n-th output), @N.path (jsonpath into output), @* (all primary values), @stdin / @stdin:path (whole envelope). See dlazy --help for details.

Output Format

{
  "ok": true,
  "result": {
    "tool": "plan",
    "modelId": "plan",
    "outputs": [
      {
        "type": "shape",
        "id": "o_xxxxxxxx",
        "shape": {}
      }
    ]
  }
}

> Async tasks (when --no-wait is passed) return outputs: [] and a task: { generateId, status } field instead. Use dlazy status --wait to poll.

Examples

dlazy plan --prompt 'prompt content'

Error Handling

| Code | Error Type | Example Message | | ---- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | 401 | Unauthorized (No API Key) | ok: false, code: "unauthorized", message: "API key is missing or invalid" | | 501 | Missing required parameter | error: required option '--prompt ' not specified | | 502 | Local file read error | Error: Image file/Video file not found: C:\path\to\your\file | | 503 | API request failed (no balance) | ok: false, code: "insufficient_balance" | | 503 | API request failed (server error) | HTTP status code error (500 server crash) | | 504 | Asynchronous task execution failed | === Generation Failed === / {Specific error reason returned by backend, for example "Prompt violates safety policy"} |

> AGENT CRITICAL INSTRUCTION: > 1. If the execution result returns code: "insufficient_balance", you MUST explicitly inform the user that their credits are insufficient and guide them to recharge: https://dlazy.com/dashboard/organization/settings?tab=credits > 2. If the execution result returns code: "unauthorized" or indicates missing API key, you MUST inform the user to get their API key from https://dlazy.com/dashboard/organization/api-key and save it using dlazy auth set and resume the task.

Tips

Visit https://dlazy.com for more information.

dlazy plan --prompt 'prompt content'

Visit https://dlazy.com for more information.