Effect Templates

# Effect Templates

Use this skill when the user wants a Freebeat effect-template clip rather than a general text-to-video model run.

## Before running CLI commands

Freebeat CLI is an npm package and authenticated API client. Install or refresh it first:

~~~bash
npm install -g freebeat-cli@latest
freebeat --help
~~~

The user must provide a Freebeat API key before generation. Use one of these patterns:

~~~bash
freebeat auth set-api-key
printf '%s' "$FREEBEAT_API_KEY" | freebeat auth set-api-key --stdin
freebeat --api-key <apiKey> <command>
~~~

Validate credentials before starting a paid or long-running workflow:

~~~bash
freebeat auth show
freebeat auth test
~~~

Do not paste or log the raw API key. Ask the user to provide it in their terminal, secret store, or environment variable.

## Discover templates

~~~bash
freebeat effects list
freebeat effects list --json
~~~

## Submit an effect task

~~~bash
freebeat effect submit --effect-id <effectId> --music-id <musicId> --image-url <imageUrl> --prompt "anime glow" --wait
~~~

## Run with template defaults

~~~bash
freebeat effect run --effect-id <effectId> --prompt "anime glow" --wait
freebeat effect run --effect-id <effectId> --audio song.mp3 --image ref.png --prompt "anime glow" --wait
~~~

Effect commands support --audio, --image, --watermark, and --wait. Use effect run when the template has default assets and the user wants a faster path.

## Check progress

Open RPC image and video commands return a batch id and serial number. Legacy MV and effect commands return a task id.

~~~bash
freebeat task status <batch-id>
freebeat task status <batch-id> --serial-no <serial-no>
freebeat task wait <batch-id> --serial-no <serial-no>
freebeat task status <task-id>
freebeat task wait <task-id>
freebeat task result <task-id>
~~~

Use --json when another agent, script, or CI job needs to parse task ids, batch ids, serial numbers, result URLs, credits, or statuses.