pixverse 1.2.13 → 1.3.0

package/README.md

@@ -269,6 +269,39 @@ These flags are available across most `create` subcommands:
 | `--no-wait`                        | Return immediately without waiting for completion |
 | `--timeout <sec>`                  | Polling timeout in seconds (default 300)          |
 
+### MiniApps
+
+MiniApps are preset, single-purpose generators from the PixVerse web app (Magic
+Extend, Image Region Editor, …). The CLI is a thin pass-through: it does not
+bundle each app's parameter schema. Instead, `miniapps info <id>` returns the
+app's **parameter schema** (required fields, types, enum values, and a
+copy-pasteable example) — read it, then submit the app id plus its `args` as JSON
+with `miniapps create`.
+
+```bash
+# List available MiniApps
+pixverse miniapps list
+
+# Show a MiniApp's details + its parameter schema (what to put in --params)
+pixverse miniapps info magic_extend          # add --json for the machine-readable params_schema
+
+# Create a MiniApp project — --id and --params are required; --params takes JSON (a literal, a file path, or - for stdin)
+pixverse miniapps create --id magic_extend --params '{"image":"<media-path>","ratio":"16:9","quality":"720p"}'
+pixverse miniapps create --id image_region_editor --params ./args.json
+
+# create returns a project_id — query / download / delete it with --type miniapps
+pixverse task status <project_id> --type miniapps
+pixverse task wait <project_id> --type miniapps
+pixverse asset info <project_id> --type miniapps
+pixverse asset download <project_id> --type miniapps --dest ./out/
+pixverse asset delete <project_id> --type miniapps
+```
+
+Media fields inside `--params` must be **media paths** — the `path` returned by
+`asset upload` (not a URL, not a local file). The CLI passes `--params` straight
+through without uploading, so upload first with `pixverse asset upload <file>` and
+use the returned `path`.
+
 ### Task Management
 
 ```bash
@@ -278,6 +311,9 @@ pixverse task status <id>
 # Poll a voice/music audio task (audio is not auto-detected — pass --type audio)
 pixverse task status <id> --type audio
 
+# Poll a MiniApp project (pass --type miniapps; project_id comes from `miniapps create`)
+pixverse task status <project_id> --type miniapps
+
 # Batch status query with space-separated IDs (parallel; per-ID failures captured)
 pixverse task status 123 456 789 --type video --json
 
@@ -296,6 +332,7 @@ pixverse asset list
 pixverse asset list --type image
 pixverse asset list --type audio              # voice and music audio history
 pixverse asset list --type audio --source upload
+pixverse asset list --type miniapps           # MiniApp projects
 pixverse asset list --source upload
 pixverse asset list --source create --off-peak
 

package/dist/capabilities.json

@@ -5,7 +5,7 @@
   "cli": {
     "name": "pixverse",
     "package": "pixverse",
-    "version": "1.2.13",
+    "version": "1.3.0",
     "binary": "pixverse",
     "node": ">=20",
     "description": "PixVerse CLI - generate videos and images from the command line"
@@ -49,6 +49,7 @@
         "template",
         "voice",
         "music",
+        "miniapps",
         "saved",
         "workspace",
         "update"
@@ -375,7 +376,7 @@
       },
       "options": {
         "--ids <ids>": "Comma-separated list of IDs for batch query (e.g. 123,456,789)",
-        "--type <type>": "Asset type: video, image, or audio | default: video",
+        "--type <type>": "Asset type: video, image, audio, or miniapps | default: video",
         "--json": "Output as JSON"
       }
     },
@@ -385,10 +386,10 @@
       "run": true,
       "auth": true,
       "args": {
-        "id": "Video, image, or audio ID"
+        "id": "Video, image, audio, or MiniApp project ID"
       },
       "options": {
-        "--type <type>": "Asset type: video, image, or audio | default: video",
+        "--type <type>": "Asset type: video, image, audio, or miniapps | default: video",
         "--timeout <seconds>": "Timeout in seconds | default: 300",
         "--json": "Output as JSON"
       }
@@ -404,7 +405,7 @@
       "run": true,
       "auth": true,
       "options": {
-        "--type <type>": "Asset type: video, image, or audio | default: video | choices: video, image, audio",
+        "--type <type>": "Asset type: video, image, audio, or miniapps | default: video | choices: video, image, audio, miniapps",
         "--source <source>": "Asset source: create or upload | default: create | choices: create, upload",
         "--off-peak": "Filter off-peak generations only (video + create only)",
         "--limit <number>": "Number of items per page | default: 20",
@@ -421,7 +422,7 @@
         "id": "Video, image, or audio ID"
       },
       "options": {
-        "--type <type>": "Asset type: video, image, or audio (auto-detected if omitted)",
+        "--type <type>": "Asset type: video, image, audio, or miniapps (auto-detected if omitted; miniapps must be explicit)",
         "--source <source>": "Audio source: create or upload | default: create | choices: create, upload",
         "--json": "Output as JSON"
       }
@@ -435,7 +436,7 @@
         "id": "Created video, image, or audio ID (uploads not downloadable)"
       },
       "options": {
-        "--type <type>": "Asset type: video, image, or audio (auto-detected if omitted)",
+        "--type <type>": "Asset type: video, image, audio, or miniapps (auto-detected if omitted; miniapps must be explicit)",
         "--dest <path>": "Destination directory",
         "--json": "Output as JSON"
       }
@@ -464,7 +465,7 @@
         "id": "Video, image, or audio ID"
       },
       "options": {
-        "--type <type>": "Asset type: video, image, or audio (auto-detected if omitted) | choices: video, image, audio",
+        "--type <type>": "Asset type: video, image, audio, or miniapps (auto-detected if omitted; miniapps must be explicit) | choices: video, image, audio, miniapps",
         "--source <source>": "Asset source: create or upload | default: create | choices: create, upload",
         "--json": "Output as JSON"
       }
@@ -702,6 +703,46 @@
         "--json": "Output as JSON"
       }
     },
+    {
+      "cmd": "pixverse miniapps",
+      "desc": "Run PixVerse MiniApps (preset generators)",
+      "children": ["list", "info", "create"]
+    },
+    {
+      "cmd": "pixverse miniapps list",
+      "desc": "List available MiniApps",
+      "run": true,
+      "auth": true,
+      "options": {
+        "--json": "Output as JSON"
+      }
+    },
+    {
+      "cmd": "pixverse miniapps info",
+      "desc": "Show a MiniApp's details",
+      "run": true,
+      "auth": true,
+      "args": {
+        "id": "MiniApp id (e.g. magic_extend)"
+      },
+      "options": {
+        "--json": "Output as JSON"
+      }
+    },
+    {
+      "cmd": "pixverse miniapps create",
+      "desc": "Create a MiniApp project (returns a project_id)",
+      "run": true,
+      "auth": true,
+      "options": {
+        "--id <app_id>": "MiniApp id, e.g. magic_extend or image_region_editor",
+        "--params <input>": "App args as JSON (required) - a literal string, a file path, or - for stdin",
+        "--output <path>": "Download the finished main asset to this directory",
+        "--no-wait": "Return immediately with the project_id, without polling | negates: wait",
+        "--timeout <seconds>": "Polling timeout in seconds | default: 300",
+        "--json": "Output as JSON"
+      }
+    },
     {
       "cmd": "pixverse saved",
       "desc": "Manage saved folders and their contents",