Docs-derived OpenAPI spec for WaveSpeed AI's REST API. WaveSpeed is a
unified AI generation platform for image, video, audio, 3D, and LLM models.
The dynamic model-run endpoint is not represented as a generated OpenAPI
path because WaveSpeed model IDs are slash-delimited API paths such as
wavespeed-ai/hunyuan-video/t2v; ordinary OpenAPI path-parameter clients
correctly percent-encode slashes. The printed CLI adds a hand-authored
run command that submits to the literal model path.
Learn more at Wavespeed.
Created by @cathrynlavery (Cathryn Lavery).
Quick Start
1. Install
See Install above.
2. Set Up Credentials
Get your API key from your API provider's developer portal. The key typically looks like a long alphanumeric string.
export WAVESPEED_API_KEY="<paste-your-key>"
You can also persist this in your config file at ~/.config/wavespeed-pp-cli/config.toml.
3. Verify Setup
wavespeed-pp-cli doctor
This checks your configuration and credentials.
4. Try Your First Command
wavespeed-pp-cli billings
Usage
Run wavespeed-pp-cli --help for the full command reference and flag list.
Commands
account_balance
Manage account balance
wavespeed-pp-cli account-balance - Retrieve the authenticated account balance.
billings
Billing and usage records
wavespeed-pp-cli billings - Search billing records for the authenticated account.
media_uploads
Manage media uploads
wavespeed-pp-cli media-uploads - Upload a binary file to WaveSpeed media storage.
model_pricing
Manage model pricing
wavespeed-pp-cli model-pricing - Estimate the unit price for a model run using the same inputs that will be submitted to the model endpoint.
models
Model catalog and model metadata
wavespeed-pp-cli models - List available WaveSpeed models and their API schemas.
run
Submit generation tasks to slash-delimited WaveSpeed model paths.
wavespeed-pp-cli run <model-id> --input '<json>' - Submit a model run with JSON inputs.wavespeed-pp-cli run <model-id> --input-file request.json --price --wait --download - Price, submit, poll, and download output URLs.
prediction_deletions
Manage prediction deletions
wavespeed-pp-cli prediction-deletions - Delete one or more predictions from history.
prediction_results
Manage prediction results
wavespeed-pp-cli prediction-results <task_id> - Retrieve the latest status and result payload for a prediction task.
predictions
Prediction submission history and result retrieval
wavespeed-pp-cli predictions - Query recent prediction history. The API history window is limited; sync accumulates across runs.
usage_stats
Manage usage stats
wavespeed-pp-cli usage-stats - Retrieve usage statistics for the authenticated account.
Novel commands / Workflows (D2C content production)
A content-production layer for D2C brands posting to social (Instagram, TikTok,
Facebook, X). It is produce-only: it emits post-ready files plus a
per-platform manifest.json a downstream social-posting tool consumes. Every
novel command emits a uniform agent envelope and supports --dry-run. Novel
commands record each generation to a local library DB by default (--no-record
to opt out); a record failure surfaces in library_record_errors and never
fails a generation.
Plan — shape work before producing it:
wavespeed-pp-cli plan brief-to-shotlist --prompt "Helm Black launch" --platforms instagram,tiktok
wavespeed-pp-cli plan model-pick "short product video"
wavespeed-pp-cli plan cost-estimate shotlist.json
Produce — generate assets:
wavespeed-pp-cli pack --concept "Helm Black hero" --platforms instagram,tiktok --max-cost 5.00
wavespeed-pp-cli batch --from prompts.csv --max-cost 5.00
wavespeed-pp-cli variants --base shotlist.json --vary seed --count 4
wavespeed-pp-cli compose --steps "text->image,image->video" --prompt "..." --models m1,m2
Refine — aspects <image> re-frames to platform ratios; restyle <image> --brand helm applies a brand/style.
Library — library list|search|show|tag|export|cost-report query the recorded generation history.
QA — qa preflight <shotlist.json> runs pass/warn/fail checks (balance vs cost, model availability, prompt safety, platform request-shape, brand coverage).
Brand — brand init|show|list|apply|edit manage brand profiles that auto-merge into pack, compose, variants, restyle, and (via brand apply) run.
Full agent chain: brand apply → plan brief-to-shotlist → plan cost-estimate → qa preflight → pack, piping JSON between steps.
Output Formats
# Human-readable table (default in terminal, JSON when piped)
wavespeed-pp-cli billings
# JSON for scripting and agents
wavespeed-pp-cli billings --json
# Filter to specific fields
wavespeed-pp-cli billings --json --select id,name,status
# Dry run — show the request without sending
wavespeed-pp-cli billings --dry-run
# Submit a model run without path-encoding slash-delimited model IDs
wavespeed-pp-cli run wavespeed-ai/flux-dev --input '{"prompt":"a studio product photo"}' --wait
# Agent mode — JSON + compact + no prompts in one flag
wavespeed-pp-cli billings --agent
Agent Usage
This CLI is designed for AI agent consumption:
- Non-interactive - never prompts, every input is a flag
- Pipeable -
--json output to stdout, errors to stderr
- Filterable -
--select id,name returns only fields you need
- Previewable -
--dry-run shows the request without sending
- Explicit retries - add
--idempotent to create retries when a no-op success is acceptable
- Confirmable -
--yes for explicit confirmation of destructive actions
- Piped input - write commands can accept structured input when their help lists
--stdin
- Offline-friendly - sync/search commands can use the local SQLite store when available
- Agent-safe by default - no colors or formatting unless
--human-friendly is set
Exit codes: 0 success, 2 usage error, 3 not found, 4 auth error, 5 API error, 7 rate limited, 10 config error.
Health Check
wavespeed-pp-cli doctor
Verifies configuration, credentials, and connectivity to the API.
Configuration
Config file: ~/.config/wavespeed-pp-cli/config.toml
Static request headers can be configured under headers; per-command header overrides take precedence.
Environment variables:
| Name | Kind | Required | Description |
|---|
WAVESPEED_API_KEY | per_call | Yes | Set to your API credential. |
agentcookie (optional)
If you use agentcookie to sync secrets across machines, this CLI auto-adopts agentcookie-managed credentials with no extra setup. When the daemon writes to this CLI's config, wavespeed-pp-cli doctor reports agentcookie: detected and auth-status labels the source as agentcookie. Skip this section if you don't use agentcookie - the CLI works the same as any other.
Troubleshooting
Authentication errors (exit code 4)
- Run
wavespeed-pp-cli doctor to check credentials
- Verify the environment variable is set:
echo $WAVESPEED_API_KEY
Not found errors (exit code 3)
- Check the resource ID is correct
- Run the
list command to see available items
Generated by CLI Printing Press