Skip to content

docs: fix stale README examples and align model IDs with the SDKs#70

Merged
danmrichards merged 2 commits into
mainfrom
docs/readme-fixes
Jun 19, 2026
Merged

docs: fix stale README examples and align model IDs with the SDKs#70
danmrichards merged 2 commits into
mainfrom
docs/readme-fixes

Conversation

@felixsanz

Copy link
Copy Markdown
Contributor

Accuracy and consistency pass on the README.

  • Removed model: elevenlabs:1@1 was deleted in the recent schemas cleanup. Swapped the music example to minimax:music@2.6.
  • Undocumented command: added a model upload section (it exists in the CLI but was absent from the README).
  • Model-ID alignment: example IDs now match the TypeScript and Python SDK READMEs: runware:400@1 (image), google:3@3 (video), google:gemma@4-31b (text), alibaba:qwen@3-tts-1.7b-voicedesign (TTS). Applied to the run examples and the completion demo.
  • -F shorthand: documented on the --format global flag.
  • --task-type: expanded to list 3dInference and operations like removeBackground.

Every swapped AIR was verified to exist in the model catalog. Command names stay idiomatic (no API-style renames).

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>
@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. To trigger a review, include coderabbit-review in the PR description. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: bf3896c5-45fe-4874-843a-ae61fd1ad141

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

Comment @coderabbitai help to get the list of available commands and usage tips.

google:3@3 (Veo) requires width and height. minimax:music@2.6 requires either settings.lyrics or settings.instrumental. Both examples were verified against the live API.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@danmrichards danmrichards merged commit ba17158 into main Jun 19, 2026
4 checks passed
@danmrichards danmrichards deleted the docs/readme-fixes branch June 19, 2026 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants