> ## Documentation Index
> Fetch the complete documentation index at: https://gccai.heqingsong.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Gerar Música

> Flow Music gera música a partir de texto. Suporta prompts de estilo / letras / BPM / controle de duração, gerando uma música por requisição

```bash cURL theme={null}
curl --request POST \
  --url https://gccai.heqingsong.uk/v1/music/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "flowmusic",
    "title": "My Song",
    "sound_prompt": "upbeat pop music with piano",
    "bpm": "120",
    "length": 60
  }'
```

```python Python theme={null}
import requests

url = "https://gccai.heqingsong.uk/v1/music/generations"

payload = {
    "model": "flowmusic",
    "title": "My Song",
    "sound_prompt": "upbeat pop music with piano",
    "bpm": "120",
    "length": 60
}

headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript JavaScript theme={null}
const url = "https://gccai.heqingsong.uk/v1/music/generations";

const payload = {
  model: "flowmusic",
  title: "My Song",
  sound_prompt: "upbeat pop music with piano",
  bpm: "120",
  length: 60
};

const headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
};

fetch(url, {
  method: "POST",
  headers: headers,
  body: JSON.stringify(payload)
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

```json 200 theme={null}
{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01K8AYYM6R03TGZ3Q2P0TZVNPX"
    }
  ]
}
```

```json 400 theme={null}
{
  "error": {
    "message": "sound_prompt and lyrics cannot both be empty",
    "type": "invalid_request",
    "param": "",
    "code": "invalid_request"
  }
}
```

```json 403 theme={null}
{
  "error": {
    "message": "Saldo insuficiente",
    "type": "invalid_request",
    "param": "",
    "code": "quota_not_enough"
  }
}
```

```json 429 theme={null}
{
  "error": {
    "message": "A capacidade do grupo atual está saturada, tente novamente mais tarde",
    "type": "rate_limit_error",
    "param": "",
    "code": "rate_limit_error"
  }
}
```

## Autenticação

**Authorization** `string` *required*

Todos os endpoints exigem autenticação via Bearer Token

Obtenha sua API Key:

Acesse a [página de gerenciamento de API Keys](https://gccai.heqingsong.uk/keys) para obter sua API Key

Ao usar, adicione ao cabeçalho da requisição:

```
Authorization: Bearer YOUR_API_KEY
```

## Parâmetros da Requisição

**model** `string` *required*

Nome do modelo, **sempre passe `"flowmusic"`** (não diferencia maiúsculas de minúsculas)

**sound\_prompt** `string`

Prompt de descrição do estilo musical ou do som

Exemplo: `"upbeat pop music with piano"`

> [!NOTE]
>
> `sound_prompt` e `lyrics` **não podem estar ambos vazios** (informe pelo menos um). Cada requisição gera apenas uma música.

**lyrics** `string`

Texto da letra; você pode obtê-lo primeiro com o endpoint [Gerar Letras](https://gccai.heqingsong.uk/pt/api-reference/audios/flow-music/lyrics.md) e reutilizá-lo aqui

Exemplo: `"[Verse 1]\nPor mais longa que seja a noite, o dia sempre chega\n..."`

**title** `string`

Título da música gerada

**bpm** `string`

BPM (batidas por minuto), deve ser ≥ 1

Exemplo: `"120"`

**length** `integer`

Duração da geração (segundos)

Faixa suportada: `1` \~ `240` segundos

**seed** `string`

Semente aleatória, usada para reproduzir resultados

> [!NOTE]
>
> Enviar o mesmo valor de seed na mesma requisição gera resultados semelhantes, mas não garante resultados totalmente idênticos.

## Resposta

**code** `integer`

Código de status da resposta, 200 em caso de sucesso

**data** `array`

Array de dados retornados

**Elementos do array**

**status** `string`

Status da tarefa, `submitted` no envio inicial

**task\_id** `string`

Identificador único da tarefa, usado para consultar o status e o resultado da tarefa

## Casos de Uso

### Cenário 1: Geração apenas com prompt de estilo

```json theme={null}
{
  "model": "flowmusic",
  "title": "My Song",
  "sound_prompt": "upbeat pop music with piano",
  "bpm": "120",
  "length": 60
}
```

### Cenário 2: Letra + estilo para compor a música

```json theme={null}
{
  "model": "flowmusic",
  "title": "Perseverança",
  "lyrics": "[Verse 1]\nPor mais longa que seja a noite, o dia sempre chega\n...",
  "sound_prompt": "energetic rock with electric guitar",
  "length": 120
}
```

> [!NOTE]
>
> **Consultar o Resultado da Tarefa**
>
> A geração de música é uma tarefa assíncrona; após o envio, um `task_id` é retornado. Use o endpoint [Obter Status da Tarefa](https://gccai.heqingsong.uk/pt/api-reference/audios/flow-music/query.md) para consultar o progresso e o resultado da geração.

## Exemplo de Resultado de Tarefa Concluída

**Exemplo de resposta da consulta** (`GET /v1/music/tasks/{task_id}`):

```json theme={null}
{
  "code": 200,
  "data": {
    "id": "task_01KWXVB61E28THHFBSYXWA4FAJ",
    "status": "completed",
    "progress": 100,
    "created": 1783413184,
    "completed": 1783413236,
    "actual_time": 52,
    "cost": 0.048,
    "credits_cost": 0.48,
    "result": {
      "music": [
        {
          "clip_id": "a41aade4-993e-4d28-b56f-d97e7ef7167c",
          "title": "Regression Song",
          "duration_seconds": "181.70666667",
          "create_time": "2026-07-07T08:33:32.854073Z",
          "lyrics": "[Verse 1]\nWaking up to the morning light,\n...",
          "lyrics_id": "c302d603-81b6-552f-8122-e512928d6aa1",
          "lyrics_timing_markers": [[10, 12], [212, 36]],
          "audio_url": "https://gccai.heqingsong.uk/_gccai/cdn/audio/flowmusic_a41aade4.m4a",
          "wav_url": "https://gccai.heqingsong.uk/_gccai/cdn/audio/flowmusic_a41aade4.wav",
          "image_url": "https://gccai.heqingsong.uk/_gccai/cdn/image/flowmusic_a41aade4_cover.jpg"
        }
      ]
    }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.