> ## 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.

# Générer de la musique

> Flow Music génère de la musique à partir de texte. Prend en charge les prompts de style / paroles / BPM / contrôle de la durée, chaque requête génère un morceau de musique

```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": "Solde insuffisant",
    "type": "invalid_request",
    "param": "",
    "code": "quota_not_enough"
  }
}
```

```json 429 theme={null}
{
  "error": {
    "message": "La capacité du groupe actuel est saturée, veuillez réessayer plus tard",
    "type": "rate_limit_error",
    "param": "",
    "code": "rate_limit_error"
  }
}
```

## Authentification

**Authorization** `string` *required*

Toutes les API nécessitent une authentification par Bearer Token

Obtenir une clé API :

Rendez-vous sur la [page de gestion des clés API](https://gccai.heqingsong.uk/keys) pour obtenir votre clé API

Ajoutez-la dans l'en-tête de la requête lors de l'utilisation :

```
Authorization: Bearer YOUR_API_KEY
```

## Paramètres de requête

**model** `string` *required*

Nom du modèle, **toujours passer `"flowmusic"`** (insensible à la casse)

**sound\_prompt** `string`

Prompt décrivant le style musical ou le son

Exemple : `"upbeat pop music with piano"`

> [!NOTE]
>
> `sound_prompt` et `lyrics` **ne peuvent pas être vides tous les deux** (au moins un des deux doit être fourni). Chaque requête ne génère qu'un seul morceau de musique.

**lyrics** `string`

Texte des paroles, que vous pouvez d'abord obtenir via l'API [Générer des paroles](https://gccai.heqingsong.uk/fr/api-reference/audios/flow-music/lyrics.md) puis réinjecter ici

Exemple : `"[Verse 1]\nMême la nuit la plus longue finit par s'éclairer\n..."`

**title** `string`

Titre de la musique générée

**bpm** `string`

BPM (battements par minute), doit être ≥ 1

Exemple : `"120"`

**length** `integer`

Durée de génération (secondes)

Plage prise en charge : `1` \~ `240` secondes

**seed** `string`

Graine aléatoire, utilisée pour reproduire les résultats

> [!NOTE]
>
> Passer la même valeur de seed avec la même requête produit des résultats similaires, mais une identité parfaite n'est pas garantie.

## Réponse

**code** `integer`

Code de statut de la réponse, 200 en cas de succès

**data** `array`

Tableau de données renvoyées

**Éléments du tableau**

**status** `string`

Statut de la tâche, `submitted` lors de la soumission initiale

**task\_id** `string`

Identifiant unique de la tâche, utilisé pour interroger le statut et le résultat de la tâche

## Cas d'usage

### Scénario 1 : génération à partir d'un simple prompt de style

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

### Scénario 2 : paroles + style pour composer un morceau

```json theme={null}
{
  "model": "flowmusic",
  "title": "Persévérance",
  "lyrics": "[Verse 1]\nMême la nuit la plus longue finit par s'éclairer\n...",
  "sound_prompt": "energetic rock with electric guitar",
  "length": 120
}
```

> [!NOTE]
>
> **Interroger le résultat de la tâche**
>
> La génération de musique est une tâche asynchrone ; après soumission, un `task_id` est renvoyé. Utilisez l'API [Obtenir le statut de la tâche](https://gccai.heqingsong.uk/fr/api-reference/audios/flow-music/query.md) pour interroger la progression et le résultat de la génération.

## Exemple de résultat de tâche terminée

**Exemple de réponse de requête** (`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.