Creative
Beta

creative_music_generate

Start a music generation job with a catalog model in the connected workspace.

Operation

Write. Requires read-and-write OAuth consent.

Parameters

ParameterTypeRequiredDescription
body.promptstringYesDescribe the music in up to 5,000 characters.
body.modelstringNoModel ID from creative_music_models_list. Defaults to orchestor/music-auto.
body.image_urlstring or nullNoPublic HTTPS reference image.
body.modestringNoUse async to receive a job immediately.
idempotency_keystringYesReuse the key to retry the same input.
approval_receiptstringNoPlan receipt to submit after confirmation.

The auto model selects lyria-3-pro. Both catalog entries use Lyria 3 Pro. Give length guidance in the prompt. The current catalog has no explicit duration control. The result contains an MP3 URL.

After confirming the plan, resubmit with its approval_receipt. Pass data.job.id to creative_jobs_wait, then retrieve the output with creative_jobs_result.

Sample prompt

Generate a slow piano piece with lyria-3-pro and return the MP3 when it is ready.