Skip to content

Commit 3cd1fac

Browse files
felixsanzclaude
andcommitted
docs: fix stale README examples and align model IDs with the SDKs
Replaces the removed elevenlabs:1@1 music example with minimax:music@2.6, documents the previously-missing model upload command, aligns example model IDs with the SDK READMEs (runware:400@1, google:3@3, google:gemma@4-31b, alibaba voicedesign TTS) across the run examples and completion demo, adds the -F shorthand to --format, and expands --task-type to cover 3dInference and operations. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 86db2c1 commit 3cd1fac

1 file changed

Lines changed: 31 additions & 18 deletions

File tree

README.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ runware auth login
4141
runware ping
4242

4343
# Generate an image
44-
runware run runware:101@1 positivePrompt="a chess match in the park" width=1024 height=1024
44+
runware run runware:400@1 positivePrompt="a chess match in the park" width=1024 height=1024
4545

4646
# Check your account details
4747
runware account details
@@ -64,7 +64,7 @@ runware run <model> [key=value ...] [flags]
6464
| Flag | Description |
6565
|------|-------------|
6666
| `--preset` | Load parameters from a saved preset (model and params used as defaults; `<model>` may be omitted when the preset provides one) |
67-
| `--task-type` | Override detected task type (e.g. `imageInference`, `videoInference`, `audioInference`, `textInference`) |
67+
| `--task-type` | Override the detected task type. Accepts any API task type, e.g. `imageInference`, `videoInference`, `audioInference`, `textInference`, `3dInference`, or an operation like `removeBackground` |
6868
| `--output-dir` | Directory to save downloaded output files (default `./outputs`) |
6969
| `--no-download` | Skip auto-downloading media files |
7070
| `--delivery-method` | Delivery method (`sync` or `async`) (default `async`) |
@@ -75,13 +75,13 @@ runware run <model> [key=value ...] [flags]
7575

7676
```shell
7777
# Text-to-image
78-
runware run runware:101@1 positivePrompt="A serene mountain landscape" width=1024 height=1024
78+
runware run runware:400@1 positivePrompt="A serene mountain landscape" width=1024 height=1024
7979

8080
# Save to a specific directory
81-
runware run runware:101@1 positivePrompt="Abstract art" --output-dir ./my-images width=1024 height=1024
81+
runware run runware:400@1 positivePrompt="Abstract art" --output-dir ./my-images width=1024 height=1024
8282

8383
# Get the URL without downloading
84-
runware run runware:101@1 positivePrompt="Abstract art" --format json --no-download
84+
runware run runware:400@1 positivePrompt="Abstract art" --format json --no-download
8585

8686
# Community model — specify task type explicitly
8787
runware run civitai:305149@392545 --task-type imageInference positivePrompt="A portrait" width=1024 height=1024
@@ -90,27 +90,27 @@ runware run civitai:305149@392545 --task-type imageInference positivePrompt="A p
9090
#### Video generation
9191

9292
```shell
93-
runware run klingai:5@3 positivePrompt="Ocean waves at sunset" width=1920 height=1080 duration=10
93+
runware run google:3@3 positivePrompt="Ocean waves at sunset" duration=8
9494
```
9595

9696
#### Audio generation
9797

9898
```shell
9999
# Music generation
100-
runware run elevenlabs:1@1 positivePrompt="Upbeat electronic dance music with driving bass and synth leads" duration=30
100+
runware run minimax:music@2.6 positivePrompt="Upbeat electronic dance music with driving bass and synth leads"
101101

102-
# Text-to-speech
103-
runware run minimax:speech@2.8 speech.text="Hello, this is a text-to-speech example." speech.voice=English_expressive_narrator
102+
# Text-to-speech (the voice is designed from the prompt)
103+
runware run alibaba:qwen@3-tts-1.7b-voicedesign positivePrompt="A calm, friendly young woman with a soft tone" speech.text="Hello, this is a text-to-speech example." speech.voice=design
104104
```
105105

106106
#### Text inference (LLM)
107107

108108
```shell
109109
# Single message
110-
runware run minimax:m3@0 messages.0.role=user messages.0.content="Explain quantum computing"
110+
runware run google:gemma@4-31b messages.0.role=user messages.0.content="Explain quantum computing"
111111

112112
# Multi-turn conversation
113-
runware run minimax:m3@0 \
113+
runware run google:gemma@4-31b \
114114
messages.0.role=user messages.0.content="What is Go?" \
115115
messages.1.role=assistant messages.1.content="A compiled language." \
116116
messages.2.role=user messages.2.content="How do I install it?"
@@ -152,6 +152,19 @@ runware model schema google:3@2 # Show request parameter
152152
runware model schema google:3@2 --response # Show response schema instead
153153
```
154154

155+
Upload a custom model to your account (WebSocket transport only):
156+
157+
```shell
158+
runware model upload \
159+
--air "myorg:my-model@1.0" \
160+
--name "My Custom Model" \
161+
--category checkpoint \
162+
--architecture sdxl \
163+
--download-url "https://example.com/model.safetensors"
164+
```
165+
166+
Run `runware model upload --help` for the full flag set (LoRA trigger words, default scheduler and steps, visibility, and more). Your AIR source is shown by `runware account details`.
167+
155168
### Presets
156169

157170
Save frequently used configurations:
@@ -202,7 +215,7 @@ runware completion # Generate shell completions (bash/zsh/fish/powe
202215

203216
| Flag | Description |
204217
|------|-------------|
205-
| `--format json\|yaml\|table` | Output format (default: table) |
218+
| `-F, --format json\|yaml\|table` | Output format (default: table) |
206219
| `-v, --verbose` | Show request/response details |
207220
| `--debug` | Full debug output |
208221
| `--transport ws\|http` | Transport protocol: WebSocket or REST (default: `defaults.transport` from config, or `ws`) |
@@ -338,26 +351,26 @@ version
338351
339352
# Complete model AIR identifiers for `run`
340353
$ runware run <Tab>
341-
runware:101@1 -- FLUX Dev — fast, high-quality image generation
342-
minimax:m3@0 -- MiniMax M3 text model
343-
klingai:5@3 -- Kling AI video generation
354+
runware:400@1 -- FLUX.2 [dev] image generation
355+
google:gemma@4-31b -- Gemma text model
356+
google:3@3 -- Veo 3.1 video generation
344357
...
345358
346359
# Complete parameter names (schema-driven, per model)
347-
$ runware run runware:101@1 <Tab>
360+
$ runware run runware:400@1 <Tab>
348361
positivePrompt= -- Text prompt describing the image
349362
width= -- Output width in pixels
350363
height= -- Output height in pixels
351364
steps= -- Number of diffusion steps
352365
...
353366
354367
# Array fields use dot-notation with auto-advancing indices
355-
$ runware run minimax:m3@0 <Tab>
368+
$ runware run google:gemma@4-31b <Tab>
356369
messages.0.role= -- Role of the message sender
357370
messages.0.content= -- Content of the message
358371
359372
# After messages.0.* are filled, next Tab suggests index 1
360-
$ runware run minimax:m3@0 messages.0.role=user messages.0.content="What is Go?" <Tab>
373+
$ runware run google:gemma@4-31b messages.0.role=user messages.0.content="What is Go?" <Tab>
361374
messages.1.role= -- Role of the message sender
362375
messages.1.content= -- Content of the message
363376
```

0 commit comments

Comments
 (0)