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

# Générer des paroles

> Flow Music génère des paroles à partir d'un prompt. Le résultat peut être réinjecté dans le champ lyrics de l'API de génération de musique

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://api.apimart.ai/v1/music/generations/lyricsFlowMusic \
    --header 'Authorization: Bearer <token>' \
    --header 'Content-Type: application/json' \
    --data '{
      "model": "flowmusic",
      "prompt": "Une chanson rock sur la persévérance"
    }'
  ```

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

  url = "https://api.apimart.ai/v1/music/generations/lyricsFlowMusic"

  payload = {
      "model": "flowmusic",
      "prompt": "Une chanson rock sur la persévérance"
  }

  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://api.apimart.ai/v1/music/generations/lyricsFlowMusic";

  const payload = {
    model: "flowmusic",
    prompt: "Une chanson rock sur la persévérance"
  };

  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));
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "code": 200,
    "data": [
      {
        "status": "submitted",
        "task_id": "task_01KWXVCX91HYHSTHZ0NC1SRFW1"
      }
    ]
  }
  ```

  ```json 400 theme={null}
  {
    "error": {
      "message": "model is required",
      "type": "invalid_request",
      "param": "",
      "code": "model_required"
    }
  }
  ```

  ```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"
    }
  }
  ```
</ResponseExample>

## Authentification

<ParamField header="Authorization" type="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://apimart.ai/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
  ```
</ParamField>

## Paramètres de requête

<ParamField body="model" type="string" required>
  Nom du modèle, **toujours passer `"flowmusic"`** (insensible à la casse)
</ParamField>

<ParamField body="prompt" type="string" required>
  Prompt pour générer les paroles, **≤ 3000 caractères**

  Il est conseillé de décrire le thème, le style et l'ambiance de la chanson pour obtenir des paroles plus adaptées

  Exemple : `"Une chanson rock sur la persévérance"`
</ParamField>

## Réponse

<ResponseField name="code" type="integer">
  Code de statut de la réponse, 200 en cas de succès
</ResponseField>

<ResponseField name="data" type="array">
  Tableau de données renvoyées

  <Expandable title="Éléments du tableau">
    <ResponseField name="status" type="string">
      Statut de la tâche, `submitted` lors de la soumission initiale
    </ResponseField>

    <ResponseField name="task_id" type="string">
      Identifiant unique de la tâche, utilisé pour interroger le statut et le résultat de la tâche
    </ResponseField>
  </Expandable>
</ResponseField>

## Cas d'usage

### Scénario 1 : générer des paroles à partir d'un thème

```json theme={null}
{
  "model": "flowmusic",
  "prompt": "Une chanson rock sur la persévérance"
}
```

### Scénario 2 : réinjecter les paroles pour composer un morceau

Générez d'abord les paroles, puis récupérez le `title` et les `lyrics` de `result.lyrics[0]` et réinjectez-les dans l'API [Générer de la musique](./music) :

```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"
}
```

<Note>
  **Interroger le résultat de la tâche**

  La génération de paroles est une tâche asynchrone ; après soumission, un `task_id` est renvoyé. Utilisez l'API [Obtenir le statut de la tâche](./query) pour interroger la progression et le résultat de la génération.
</Note>

## 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_01KWXVCX91HYHSTHZ0NC1SRFW1",
    "status": "completed",
    "progress": 100,
    "created": 1783413241,
    "completed": 1783413284,
    "actual_time": 43,
    "cost": 0.016,
    "credits_cost": 0.16,
    "result": {
      "lyrics": [
        {
          "title": "Bleached",
          "lyrics": "[Intro]\n(Check)\n(One two)\n\n[Verse 1]\nThe birds are..."
        }
      ]
    }
  }
}
```