Vtrix CLI Quickstart | Vtrix API Docs

Getting Started

Install the CLI

npm install -g @vtrixai/vtrix-cli

Authenticate

Run the login command. The CLI will print a device code and authorization URL, and automatically try to open your browser. Once authorized, credentials are stored in your local keychain and reused automatically.

vtrix auth login
vtrix auth status

Run your first task

# Text to video
vtrix run spark_dance_v2_0 \
  --param prompt="dancer in neon rain, cinematic slow motion" \
  --param duration=5 \
  --output url

# Image to video
vtrix run kirin_v2_6_i2v \
  --param image=https://example.com/photo.jpg \
  --param prompt="gentle breeze, leaves swaying" \
  --output url

Full Workflow

# 1. View model parameter spec
vtrix models spec spark_dance_v2_0

# 2. Dry-run mode — preview the request without spending credits (no login required)
vtrix --dry-run run spark_dance_v2_0 --param prompt="neon city at night"

# 3. Submit task and wait for completion, --output json returns the full response
vtrix run spark_dance_v2_0 \
  --param prompt="neon city at night" \
  --output json

# 4. Query the status of an existing task (single query)
vtrix task status <task_id> --output json

# 5. Get only the result URL
vtrix task status <task_id> --output url