CLI

Official command-line interface for the VideoGen API.

The VideoGen CLI is a Node command that wraps the official @videogen/sdk and exposes every public API resource as a subcommand.

Install

Install globally with npm:

$npm install -g @videogen/cli

That puts a videogen command on your PATH. To run it once without installing, use npx:

$npx @videogen/cli --help

Authenticate

Set your API key from app.videogen.io/api as an environment variable:

$export VIDEOGEN_API_KEY="sk_videogen_live_..."

You can override the key per command with --api-key.

Quick start

List the available commands:

$videogen --help

Every API resource is a subcommand (videogen <resource> <kebab-op>). List the methods on a resource:

$videogen tools --help

Run a tool

Provide request parameters as a JSON body with --body, or pipe JSON on stdin. Tool runs are asynchronous, so the CLI prints a toolExecutionId:

$videogen tools generate-video-clip --body '{"prompt": "A sunset over a calm ocean, cinematic lighting"}'

Poll the execution until it reaches a terminal status:

$videogen tools get-tool-execution-info --tool-execution-id vg_tool_...

Output formats

Commands print JSON to stdout, so you can pipe results into jq or other tooling:

$videogen account get-me | jq '.teamId'

Common flags

These global flags work on every command:

FlagDescription
--api-key <key>API key (or set VIDEOGEN_API_KEY).
--base-url <URL>Override the API base URL.
--jsonForce JSON output (stdout is JSON by default).
--body <JSON>Supply the request body as JSON.
-h / --helpShow help.
-V / --versionShow version.

Path params are kebab flags (e.g. --workflow-run-id, --project-id, --file-id). Body-heavy POSTs accept --body '<json>' or a JSON object on stdin.