> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Gerar plano de composição

POST https://api.elevenlabs.io/v1/music/plan
Content-Type: application/json

Crie um plano de composição para geração de música. O uso deste endpoint não consome créditos, mas está sujeito a limites de taxa conforme seu plano.

Reference: https://elevenlabs.io/docs/api-reference/music/create-composition-plan

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Query parameters

- `enable_logging` (boolean, optional, default: true) — Quando enable_logging estiver definido como false, o modo de retenção zero será usado para a solicitação. O modo de retenção zero só pode ser usado por clientes empresariais.

### Body (application/json)

This endpoint expects a Body_Generate_composition_plan_v1_music_plan_post.

- `prompt` (string, required) — Um prompt de texto simples para criar um plano.
- `music_length_ms` (integer, optional, nullable) — A duração, em milissegundos, do plano de composição a ser gerado. Deve estar entre 3000 ms e 600000 ms. Opcional — se não for informada, o modelo escolherá uma duração com base no prompt.
- `source_composition_plan` (BodyGenerateCompositionPlanV1MusicPlanPostSourceCompositionPlan, optional, nullable) — Um plano de composição opcional para usar como fonte do novo plano de composição.
- `model_id` (enum, optional, default: music_v1) — O modelo a ser usado na geração.
  - Allowed values: `music_v1`, `music_v2`, `music_v2_5`

## Response

### 200

Resposta bem-sucedida

- `music_composition_plan_create_Response_200`

## Errors

### 422 Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### BodyGenerateCompositionPlanV1MusicPlanPostSourceCompositionPlan

Um plano de composição opcional para usar como fonte do novo plano de composição.

### MusicPrompt

Plano de composição para o modelo `music_v1`. Usar este campo com qualquer outro modelo resultará em erro.

- `positive_global_styles` (list of string, required) — Os estilos e direcionamentos musicais que devem estar presentes em toda a música. Use o idioma inglês para obter melhores resultados.
- `negative_global_styles` (list of string, required) — Os estilos e direcionamentos musicais que não devem estar presentes em toda a música. Use o idioma inglês para obter melhores resultados.
- `sections` (list of SongSection, required) — As seções da música.

### CompositionPlan

Plano de composição para os modelos `music_v2` e `music_v2_5`. Usar este campo com qualquer outro modelo resultará em erro.

- `chunks` (list of CompositionPlanChunksItems, required) — Os trechos que compõem a geração.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### SongSection

- `section_name` (string, required) — O nome da seção. Deve ter entre 1 e 100 caracteres.
- `positive_local_styles` (list of string, required) — Os estilos e direcionamentos musicais que devem estar presentes nesta seção. Use o idioma inglês para obter melhores resultados.
- `negative_local_styles` (list of string, required) — Os estilos e direcionamentos musicais que não devem estar presentes nesta seção. Use o idioma inglês para obter melhores resultados.
- `duration_ms` (integer, required) — A duração da seção em milissegundos. Deve estar entre 3000 ms e 120000 ms.
- `lines` (list of string, required) — A letra da seção. Máximo de 30 linhas por seção e 200 caracteres por linha.
- `source_from` (SectionSource, optional, nullable) — Fonte opcional da qual extrair a seção. Usada para inpainting.

### CompositionPlanChunksItems

### ValidationErrorLocItems

### SectionSource

- `song_id` (string, required) — O ID da música de origem da seção. Você pode encontrar o ID da música nos cabeçalhos da resposta ao gerar uma música.
- `range` (TimeRange, required) — O intervalo a extrair da música de origem.
- `negative_ranges` (list of TimeRange, optional) — Os intervalos a excluir de 'range'.

### GenerationChunk-Input

- `text` (string, required) — A configuração de texto a ser gerada para este trecho. Pode conter um nome de seção opcional entre colchetes no início, por exemplo, \[Verse 1], linhas de letra e instruções em linha entre chaves, por exemplo, \{scratching}. Os nomes de seção devem ter entre 1 e 100 caracteres. São permitidas no máximo 30 linhas, com até 200 caracteres cada.
- `duration_ms` (integer, required) — A duração do trecho em milissegundos. Deve estar entre 3000 ms e 120000 ms.
- `positive_styles` (list of string, required) — Os estilos e direcionamentos musicais que devem estar presentes neste trecho. Use o idioma inglês para obter melhores resultados. Os estilos do primeiro trecho são os mais importantes, pois definem o tom e o gênero geral. Os estilos dos trechos seguintes podem ser usados para adicionar nuances, progressão, ênfase ou mudar a direção da música. Procure incluir pelo menos 6 a 7 estilos nos primeiros trechos, até que a direção esteja definida. Estilos genéricos como 'great production quality' são boas opções padrão para adicionar à lista.
- `negative_styles` (list of string, optional) — Os estilos e direcionamentos musicais que não devem estar presentes neste trecho. Use o idioma inglês para obter melhores resultados. Deixar em branco é uma boa opção padrão; use este campo apenas se quiser evitar explicitamente um estilo ou direcionamento específico.
- `context_adherence` (enum, optional, default: high) — O quanto o modelo segue o contexto dos trechos ao redor. Uma aderência baixa permite que o modelo se desvie do contexto e seja mais criativo. Uma aderência alta torna o modelo mais consistente com o contexto.
  - Allowed values: `low`, `medium`, `high`
- `conditioning_ref` (AudioRefChunk, optional, nullable) — A referência de áudio usada para condicionar a geração. O primeiro trecho é o mais importante, pois influencia a geração de todos os trechos seguintes. Portanto, se quiser aplicar o condicionamento à música inteira, comece pelo primeiro trecho.
- `condition_strength` (enum, optional, nullable) — O quanto o modelo segue a referência de condicionamento. Uma intensidade baixa torna o modelo mais criativo e permite que ele se desvie da referência. Uma intensidade alta torna o modelo mais consistente com a referência.
  - Allowed values: `low`, `medium`, `high`, `xhigh`

### AudioRefChunk

- `song_id` (string, required) — O ID da música de origem do trecho. Você pode encontrar o ID da música nos cabeçalhos da resposta ao gerar uma música.
- `range` (TimeRange, required) — O intervalo de tempo a ser extraído da música.

### TimeRange

- `start_ms` (integer, required)
- `end_ms` (integer, required)

## Examples

**Request**

```json
{
  "prompt": "string"
}
```

**Response**

```json
{
  "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"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/music/plan"

payload = { "prompt": "string" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/music/plan';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"prompt":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/music/plan"

	payload := strings.NewReader("{\n  \"prompt\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/music/plan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.elevenlabs.io/v1/music/plan")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.elevenlabs.io/v1/music/plan', [
  'body' => '{
  "prompt": "string"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/music/plan");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"prompt\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["prompt": "string"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/music/plan")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```