Creative platformMusic

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<=4100 characters
A simple text prompt to compose a plan from.
music_length_msinteger or nullOptional3000-300000

The length of the composition plan to generate in milliseconds. Must be between 3000ms 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 and musical directions that should be present in the entire song. Use English language for best result.
negative_global_styleslist of strings
The styles and musical directions that should not be present in the entire song. Use English language for best result.
sectionslist of objects
The sections of the song.

Errors