Create composition plan

Create a composition plan for music generation. Usage of this endpoint does not cost any credits but is subject to rate limiting depending on your tier.

Headers

xi-api-keystringRequired

Request

This endpoint expects an object.
promptstringRequired<=2000 characters
A simple text prompt to compose a plan from.
music_length_msinteger or nullOptional>=10000<=300000

The length of the composition plan to generate in milliseconds. Must be between 10000ms and 300000ms. Optional - if not provided, the model will choose a length based on the prompt.

source_composition_planobject or nullOptional
An optional composition plan to use as a source for the new composition plan.
model_idenumOptionalDefaults to music_v1
The model to use for the generation.
Allowed values:

Response

Successful Response
positive_global_styleslist of strings
The styles that should be present in the entire song.
negative_global_styleslist of strings
The styles that should not be present in the entire song.
sectionslist of objects
The sections of the song.

Errors