BBramaDocs
Browse documentation

Brama CLI command reference

brama music

Compose one song through a music route, over the same dispatch as POST /v1/audio/music, and write the audio the provider encoded.

Invocation

brama music --model <ROUTE> --lyrics <TEXT> --output <FILE> [--prompt <TEXT>] [--response-format <FORMAT>] [--json] --allow-provider-cost
InputRequired/defaultMeaning
--model <ROUTE>requiredA canonical route that composes music, such as minimax/music-2.6, or a media alias.
--lyrics <TEXT>requiredThe song's words, lines separated by newlines.
--output <FILE>requiredWhere the audio is written.
--prompt <TEXT>optionalStyle, mood and instrumentation.
--response-format <FORMAT>optionalThe container, such as mp3 or wav.
--allow-provider-costrequiredAcknowledge the billable provider request.
--jsonoptional; offPrint the result as one JSON document.

Output and state

It writes the provider's audio to --output unchanged and prints route, audio (the content type), bytes and output, then exits 0.

Refusals

SentenceExitMeaning
refusing a billable music request without explicit --allow-provider-cost2Nothing was sent.
the dispatch refusal, such as an undeclared alias, a route that does not compose music, or provider_rate_limited: <provider's sentence>1The same sentences brama speak lists; no file was written.
cannot write <path>: <reason>1The audio arrived and the destination could not be written.

See media or the CLI tree.