Sign in
music-generation

Generate Composition Plan

Generate a composition plan from a prompt.

post/v1/music/plan

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

promptstring required

A simple text prompt to compose a plan from.

music_length_msinteger nullable

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

model_id'music_v1' | 'music_v2' | 'music_v2_5'

Example request

{
  "source_composition_plan": {
    "negative_global_styles": [
      "metal",
      "hip-hop",
      "country"
    ],
    "positive_global_styles": [
      "pop",
      "rock",
      "jazz"
    ],
    "sections": [
      {
        "duration_ms": 10000,
        "lines": [
          "Verse 1 lyrics"
        ],
        "negative_local_styles": [
          "metal",
          "hip-hop",
          "country"
        ],
        "positive_local_styles": [
          "pop",
          "rock",
          "jazz"
        ],
        "section_name": "Verse 1"
      }
    ]
  }
}

Response

Successful Response

OR

Example response

{
  "negative_global_styles": [
    "metal",
    "hip-hop",
    "country"
  ],
  "positive_global_styles": [
    "pop",
    "rock",
    "jazz"
  ],
  "sections": [
    {
      "duration_ms": 10000,
      "lines": [
        "Verse 1 lyrics"
      ],
      "negative_local_styles": [
        "metal",
        "hip-hop",
        "country"
      ],
      "positive_local_styles": [
        "pop",
        "rock",
        "jazz"
      ],
      "section_name": "Verse 1"
    }
  ]
}

Changes

Changed in 4 of the 49 revisions of this API.113

  • 4a6716242c9e1See the full diff
    • ●

      deleted the query request parameter enable_logging

      request-parameter-removed

  • ee57929773bf1See the full diff
    • ○

      added the new optional query request parameter enable_logging

      new-optional-request-parameter

  • 01782c0621ab1See the full diff
    • ○

      added the new music_v2_5 enum value to the request property

      request-property-enum-value-added

  • 1eeefe174b1d11See the full diff
    • ▲

      the //// response property's maxLength was increased from 6000 to 6132 for the response status

      response-property-max-length-increased

    • ○

      the ///// request property's maxLength was increased from 6000 to 6132

      request-property-max-length-increased