git:20261029.6819e96 to git:20261101.aa2c0b7

64 added, 53 removed. Audit A to A.

---

name: wavespeed

- description: Generate or edit AI media (image, video, audio, 3D) by calling the wavespeed CLI on the user's machine. Use whenever the user asks to create, edit, animate, upscale, or transform a visual asset, generate audio/TTS/music, or produce marketing creatives. Every model on the WaveSpeed platform is one `wavespeed run <id>` call.

+ description: Generate or edit AI media (image, video, audio, 3D) on WaveSpeed, through the WaveSpeed MCP tools when they are connected or the wavespeed CLI on the user's machine. Use whenever the user asks to create, edit, animate, extend, upscale, or transform an image or video, generate audio/TTS/music or 3D, or produce marketing creatives.

---

# WaveSpeed

- You have access to the `wavespeed` CLI. Every generation flows through one generic verb, `wavespeed run`, and the model id is always explicit. For plain image and video work there are also shortcut commands (see the end).

+ WaveSpeed runs every model on its platform. There are two ways in, and they do the same things:

- ## The three-step pattern

+ - **MCP tools** (`generate_image`, `generate_video`, …): use them when the WaveSpeed MCP server is connected. The hosted server cannot read local files: pass public URLs, or use the CLI for files on disk.

+ - **The `wavespeed` CLI**: use it when it is installed, for local files (`@./path`), batches and scripts.

- ```bash

- # 1. FIND a model — search the live catalog

- wavespeed models "seedream"

- wavespeed models --type image-to-video --popular

+ For plain image and video work, use the shortcuts. For anything else (audio, 3D, upscaling, a specific endpoint, exact parameters), use the generic run.

- # 2. INSPECT its inputs — dynamic schema, per model

- wavespeed run bytedance/seedream-v5.0-pro -h

+ ## Images and videos: the shortcuts

- # 3. RUN it — always pass --json so you can read the result

- wavespeed run bytedance/seedream-v5.0-pro \

- -p "a cyberpunk skyline at golden hour" \

- -i aspect_ratio="16:9" -i resolution="2k" --json

- ```

+ | Task | CLI | MCP tool |

+ |---|---|---|

+ | Image from a prompt (optionally with reference pictures) | `wavespeed generate image "<prompt>" [--image @./ref.jpg]` | `generate_image` |

+ | Edit, restyle, combine images | `wavespeed edit image "<prompt>" --image @./photo.jpg` | `edit_image` |

+ | Video from a prompt, a first/last frame, or references | `wavespeed generate video "<prompt>" [--first-frame …] [--ref-image …]` | `generate_video` |

+ | Edit a video | `wavespeed edit video "<prompt>" --video @./clip.mp4` | `edit_video` |

+ | Continue a video | `wavespeed extend video "<prompt>" --video @./clip.mp4` | `extend_video` |

- `run --json` returns `{ id, model, prompt, outputs: [url, ...], saved: [path, ...], elapsed_ms, raw }`. Keep `id` — it is the handle for `wavespeed show <id>` if anything is interrupted. Use the URL when the user wants a link. Add `--download` if they need bytes on disk.

+ They use the same models as the WaveSpeed /chat page and pick the endpoint (text, image, reference, edit) from the inputs you give. In the prompt, refer to media as `@image 1`, `@video 1`, `@audio 1`, in the order given ("put the product in @image 1 into the kitchen in @image 2").

- ## Recommended defaults

+ - **Price first for videos:** CLI `--estimate --json`, MCP `estimate_only: true`. It returns the endpoint, the exact request and the price, and submits nothing.

+ - **Models:** pass `-m` / `model` only when the user names one; a named model is never switched. Without it the default is used, or another model only when the default cannot take the inputs.

+ - **Options:** `--aspect-ratio`, `--resolution`, `--duration` (CLI) or the same fields (MCP). Set them only when the user asks; values are snapped to what the model supports, and every change is reported.

+ - CLI: add `--json` to read the result, `--download` to save files.

- | Use case | Model |

- |---|---|

- | Text → image | `bytedance/seedream-v5.0-pro` |

- | Image edit (instruction-driven) | `bytedance/seedream-v5.0-pro/edit` — requires `images: [url, ...]` |

- | Text → video | `wavespeed-ai/minimax-h3/text-to-video` |

- | Image → video | `wavespeed-ai/minimax-h3/image-to-video` — requires `image: url` |

- | Video edit (instruction-driven) | `wavespeed-ai/minimax-h3/video-edit` — requires `video: url` |

- | Video extend | `wavespeed-ai/minimax-h3/video-extend` — requires `video: url` |

+ ### Default models

- These are good starting points. MiniMax H3 is the open-weights default: cheap, fast, and native stereo audio — the best place to start. When you need the highest quality, switch to `bytedance/seedance-2.5/*` (text-to-video, image-to-video, video-edit, video-extend). Browse alternatives with `wavespeed models <query>`.

+ | | Default | Alternatives (`-m` / `model`) |

+ |---|---|---|

+ | Image | `seedream-5-pro` (Seedream 5 Pro) | `gpt-image-2.5` (GPT Image 2.5, the model behind ChatGPT Images; strong at text and photorealism), `nano-banana-2.1`, `nano-banana-pro`, `nano-banana-2`, `gpt-image-2` |

+ | Video | `seedance-2.5` (Seedance 2.5) | `seedance-2.5-turbo`, `kling-4.0`, `wan-3.0`, `wan-3.0-prime`, `minimax-h3` (cheap and fast, native stereo audio; defaults to 768p, its counterpart of 720p), older Seedance 2.0 tiers |

- ## Common recipes

+ Video resolution is 720p unless the user asks for another (MiniMax H3: 768p). Offer 480p for a cheaper draft.

+ ## Everything else: the generic run

+ Every model on the platform is one `wavespeed run <model-id>` (MCP: `run_model`). The model id is always explicit.

```bash

- # Edit an existing image — @path uploads the file and passes its URL (one step)

- wavespeed run bytedance/seedream-v5.0-pro/edit \

- -p "replace the background with a sunlit kitchen" \

- -i images='["@./input.jpg"]' --json

+ # 1. FIND a model in the live catalog (MCP: list_models)

+ wavespeed models "upscale"

+ wavespeed models --type text-to-audio --popular

- # Image-to-video — same @ marker for single-URL fields

- wavespeed run wavespeed-ai/minimax-h3/image-to-video \

- -p "subtle parallax, gentle wind" \

- -i image=@./hero.jpg -i duration=5 --json

+ # 2. INSPECT its inputs (MCP: get_model_schema)

+ wavespeed run <model-id> -h

- # Or upload separately when you need the URL itself

- URL=$(wavespeed upload ./hero.jpg --json | jq -r .url)

+ # 3. RUN it, with --json so you can read the result (MCP: run_model)

+ wavespeed run <model-id> -p "..." -i key=value --json

+ ```

- # Save outputs locally with a template

- wavespeed run ... -p "..." --download "./out/{index}.{ext}"

+ `run --json` returns `{ id, model, prompt, outputs: [url, ...], saved: [path, ...], elapsed_ms, raw }`. Keep `id`: it is the handle for `wavespeed show <id>` (MCP: `get_prediction`) if anything is interrupted. Use the URL when the user wants a link; add `--download` when they need the file on disk.

+ ```bash

+ # Local files: @path uploads the file and passes its URL

+ wavespeed run <model-id> -i image=@./photo.jpg --json

+ wavespeed run <model-id> -i images='["@./a.jpg","@./b.jpg"]' --json

+ # Or upload separately when you need the URL itself (MCP: upload_file / create_upload)

+ URL=$(wavespeed upload ./photo.jpg --json | jq -r .url)

+ # Save outputs with a template

+ wavespeed run <model-id> -p "..." --download "./out/{index}.{ext}"

```

+ The generic run never changes the user's prompt or inputs. The single exception is explicit: an `@path` value uploads that file and substitutes its hosted URL. Bare paths are never uploaded.

## Project config and aliases

If `wavespeed.json` exists (created by `wavespeed init`):

- - **`defaultModel`** — lets `wavespeed run -p "…"` (no model arg) work.

- - **Aliases** — named shortcuts that bundle model + default inputs. Run `wavespeed aliases` to see what's defined. `wavespeed run <alias> -h` shows the resolved schema. CLI `-i k=v` overrides alias defaults.

- The CLI never modifies the user's prompt or inputs. The single exception is explicit: an `@path` value uploads that file and substitutes its hosted URL. Bare paths are never uploaded.

+ - **`defaultModel`** lets `wavespeed run -p "…"` (no model arg) work.

+ - **Aliases** are named shortcuts that bundle model + default inputs. Run `wavespeed aliases` to see them; `wavespeed run <alias> -h` shows the resolved schema. CLI `-i k=v` overrides alias defaults.

## Auth

- `wavespeed status` shows whether the user is signed in. If not, ask them to run `wavespeed login` (opens https://wavespeed.ai/accesskey). **Never** ask the user to paste an API key into the chat — the CLI handles it.

+ - CLI: `wavespeed status` shows whether the user is signed in. If not, ask them to run `wavespeed login` (opens https://wavespeed.ai/accesskey).

+ - MCP: if the tools ask for authorization, the user approves the connection once (in Claude Code: `/mcp`, pick `wavespeed`).

+ - **Never** ask the user to paste an API key into the chat.

- ## Pitfalls

+ ## Cost and credits

- - Local files: use `@./file.jpg` in `-i` values. Bare paths are NOT uploaded and the model will reject them.

- - Don't invent model IDs. Always confirm via `wavespeed models` or `wavespeed schema <id>` before running.

- - Use `--json` on every `run` so you can read `outputs[0]` programmatically.

- - `wavespeed delete` requires `--yes` when run non-interactively (that includes you).

- - Cost and spend: `wavespeed price <id> -i k=v --json` estimates a run without generating or charging; `wavespeed balance` shows remaining credit; `wavespeed usage` (totals, per-model) and `wavespeed billings` (per-charge records) show what was spent.

- - If a run fails with `Insufficient credits` (or says a top-up is required), the balance is too low: do not retry. Tell the user, and give them https://wavespeed.ai/top-up to add credits (`wavespeed balance` shows the balance and the link). You cannot pay for them.

- - A `run` that fails with a gateway or network error (502/503/504, connection reset, timeout) does NOT mean the task failed, and the submit request is never retried automatically, so re-running can create a duplicate paid task. Do not re-run immediately. If the error contains a task id (`task_id` / prediction id), keep checking it with `wavespeed show <id> --json` until its status is terminal (`completed`, `failed`, `cancelled`, `timeout`, `deleted`). If no id was returned, check recent predictions with `wavespeed history --json` (add `--model <id>`; default window is the last 24h) and re-run once only if none matches. A client-side wait timeout or an interrupted `run` does not mean the task failed: tasks can run for a long time, so do not give up after a fixed time.

+ - `wavespeed price <id> -i k=v --json` (MCP: `get_price`) estimates a run without generating or charging. The shortcuts have `--estimate` / `estimate_only`.

+ - `wavespeed balance` (MCP: `get_balance`) shows the remaining credit; `wavespeed usage` and `wavespeed billings` show what was spent.

+ - If a run fails with `Insufficient credits` (or says a top-up is required), the balance is too low: do not retry. Tell the user and give them https://wavespeed.ai/top-up. You cannot pay for them.

- ## Shortcuts for common image/video work

+ ## Pitfalls

- `wavespeed generate image|video`, `wavespeed edit image|video`, `wavespeed extend video` use the WaveSpeed /chat models and choose the endpoint from the inputs (`--image`, `--first-frame`, `--ref-image/--ref-video/--ref-audio`, `--video`; `@./path` uploads). Pass `-m` only when the user names a model. Run with `--estimate --json` first for videos; the request may be adapted to the model and the changes are printed. Use `wavespeed run <model>` for exact control.

+ - Don't invent model IDs. Confirm with `wavespeed models` or `wavespeed schema <id>` (MCP: `list_models`, `get_model_schema`) before a generic run.

+ - Local files: use `@./file.jpg`. Bare paths are NOT uploaded and the model will reject them. The hosted MCP server cannot read local files at all.

+ - `wavespeed delete` requires `--yes` when run non-interactively (that includes you).

+ - A run that fails with a gateway or network error (502/503/504, connection reset, timeout) does NOT mean the task failed, and the submit request is never retried automatically, so re-running can create a duplicate paid task. Do not re-run immediately. If the error contains a task id (`task_id` / prediction id), keep checking it with `wavespeed show <id> --json` (MCP: `get_prediction`) until its status is terminal (`completed`, `failed`, `cancelled`, `timeout`, `deleted`). If no id was returned, check recent predictions with `wavespeed history --json` (MCP: `list_predictions`; add the model; default window is the last 24h) and re-run once only if none matches. A client-side wait timeout or an interrupted run does not mean the task failed: tasks can run for a long time, so do not give up after a fixed time.