Command reference

This page lists the current developer-platform CLI surface from sumelabs/cli. This page intentionally does not include older consumer-product commands that are not supported. Image/Video/Music generators do not exist as CLI subcommands at this time.

Use these commands to find the exact schemas at runtime:

Auth and account

sume me and sume account get both read account context for the configured key.

Read commands

sume models list stays as a deprecated alias for sume catalog list.

Jobs helpers

Assets

Asset registration and upload paths are write-gated. When first-party asset ids are not necessary, it is better to use public HTTPS URLs in generation payloads. Refer to Jobs and media.

Write and paid generation (Avatar)

Each write command must have explicit confirmation. At this time, the paid Avatar generators are the only first-class path to submit a generation in the CLI.

When provider execution can spend credits, use --confirm-paid. For non-paid writes such as job cancellation or asset registration, use --confirm-submit. Before you submit, make sure that the estimated length of the avatar-video script is 4-60 seconds inclusive. If you do not send Avatar Video quality, the default is plus.

The CLI also has batch helpers in sume avatars batch and sume avatar-videos batch (plan / create / watch / result against local state files). To examine them, use sume avatars batch --help.

Not available as CLI generators

The CLI does not ship sume image, sume video, sume music, or similar subcommands. For these families, use the HTTP API:

Family	Guide
Image 1.0	Image
Video 1.0	Video
Music 1.0	Music

After you use the API to submit those jobs, you can still recover them. Use sume jobs status / sume jobs result / sume jobs download.