LinkModel API Documentation

The LinkModel CLI is the official command-line client for LinkModel. Use it to create generation tasks, poll task status, download artifacts, inspect model schemas, and automate image or video generation from your terminal.

Guides

Installation

Install the CLI, verify the command, and choose between lkm and linkmodel.

Authentication

Configure API keys for local use, CI jobs, and one-off commands.

Image Generation

Generate images, pass reference images, and download output files.

Video Generation

Generate videos, set duration and resolution, and resume long-running tasks.

Model Schemas

Inspect bundled model parameters before choosing CLI flags.

Automation

Use JSON output, exit codes, and task status commands in scripts.

Troubleshooting

Diagnose authentication, parameter, timeout, and download issues.

Common Workflow

Install and authenticate once:

npm install -g linkmodel-cli
lkm setup

Generate an image:

lkm image "a product photo on a clean studio background"

Generate a video:

lkm video "a cinematic product orbit"

Inspect model-specific flags:

lkm models show kling-v3

Command Names

The package installs two command names:

Command	Description
`lkm`	Short command used throughout these docs.
`linkmodel`	Descriptive alias with the same behavior.

Resources

GitHub: linkmodelhq/linkmodel-cli
npm: linkmodel-cli

​Guides