Skip to content

README.md

Latest commit

 

History

History
112 lines (73 loc) · 2.17 KB

README.md

File metadata and controls

112 lines (73 loc) · 2.17 KB

modellix-cli

modellix-cli is the official command line tool for Modellix. It helps you submit model generation tasks and query task results directly from terminal.

Install

npm install -g modellix-cli

Check installation:

modellix-cli --version

Authentication

You can provide API key in two ways:

  • Preferred: set environment variable once (MODELLIX_API_KEY)
  • Alternative: pass --api-key in each command

Set env var:

# macOS / Linux
export MODELLIX_API_KEY="your_api_key"
# Windows PowerShell
$env:MODELLIX_API_KEY="your_api_key"

Core Commands

1) Create a model task

Use inline JSON body:

modellix-cli model invoke --model-slug bytedance/seedream-4.5-t2i --body '{"prompt":"A cute cat playing in a garden on a sunny day"}'

Use JSON file body:

modellix-cli model invoke --model-slug alibaba/qwen-image-edit --body-file ./payload.json

Common flags:

  • --model-slug (required): model slug in provider/model format, for example bytedance/seedream-4.5-t2i
  • --body: request JSON string
  • --body-file: path to request JSON file
  • --api-key: API key (overrides env var)

2) Query task result

modellix-cli task get <task_id>

Example:

modellix-cli task get task-abc123

Recommended Workflow

  1. Run modellix-cli model invoke ... and copy the returned task_id.
  2. Run modellix-cli task get <task_id> to get status and result.

Troubleshooting

401 Unauthorized

  • Your API key is missing, invalid, or expired.
  • Verify MODELLIX_API_KEY or pass --api-key explicitly.

402 Payment Required

  • Your account balance is insufficient.
  • Recharge your account in the Modellix console and retry.

429 Too Many Requests

  • You have hit rate limit or concurrency limit.
  • Retry with exponential backoff (for example: 1s, 2s, 4s).

Help

View all commands:

modellix-cli --help

View help for one command:

modellix-cli <command> --help

Related Links