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

# Songtext generieren

> Flow Music generiert Songtexte anhand eines Prompts. Das Ergebnis kann in das Feld lyrics des Endpunkts zur Musikgenerierung eingefügt werden

<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": "Ein Rocksong über Durchhaltevermögen"
    }'
  ```

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

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

  payload = {
      "model": "flowmusic",
      "prompt": "Ein Rocksong über Durchhaltevermögen"
  }

  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: "Ein Rocksong über Durchhaltevermögen"
  };

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

  ```json 429 theme={null}
  {
    "error": {
      "message": "Die aktuelle Gruppenkapazität ist ausgelastet, bitte später erneut versuchen",
      "type": "rate_limit_error",
      "param": "",
      "code": "rate_limit_error"
    }
  }
  ```
</ResponseExample>

## Authentifizierung

<ParamField header="Authorization" type="string" required>
  Alle Endpunkte erfordern eine Authentifizierung per Bearer Token

  API Key erhalten:

  Besuchen Sie die [API-Key-Verwaltungsseite](https://apimart.ai/keys), um Ihren API Key zu erhalten

  Fügen Sie ihn bei der Verwendung dem Request-Header hinzu:

  ```
  Authorization: Bearer YOUR_API_KEY
  ```
</ParamField>

## Anfrageparameter

<ParamField body="model" type="string" required>
  Modellname, **immer `"flowmusic"` übergeben** (Groß-/Kleinschreibung wird nicht beachtet)
</ParamField>

<ParamField body="prompt" type="string" required>
  Prompt für die Songtextgenerierung, **≤ 3000 Zeichen**

  Empfohlen wird eine Beschreibung von Thema, Stil und Stimmung des Songs, um passendere Songtexte zu erhalten

  Beispiel: `"Ein Rocksong über Durchhaltevermögen"`
</ParamField>

## Antwort

<ResponseField name="code" type="integer">
  Antwortstatuscode, bei Erfolg 200
</ResponseField>

<ResponseField name="data" type="array">
  Array der zurückgegebenen Daten

  <Expandable title="Array-Elemente">
    <ResponseField name="status" type="string">
      Aufgabenstatus, bei der ersten Übermittlung `submitted`
    </ResponseField>

    <ResponseField name="task_id" type="string">
      Eindeutige Aufgaben-ID, dient zum Abfragen von Aufgabenstatus und Ergebnis
    </ResponseField>
  </Expandable>
</ResponseField>

## Anwendungsfälle

### Szenario 1: Songtext nach Thema generieren

```json theme={null}
{
  "model": "flowmusic",
  "prompt": "Ein Rocksong über Durchhaltevermögen"
}
```

### Szenario 2: Songtext in die Musikgenerierung übernehmen

Zuerst den Songtext generieren, nach Abschluss `title` und `lyrics` aus `result.lyrics[0]` entnehmen und in den Endpunkt [Musik generieren](./music) einfügen:

```json theme={null}
{
  "model": "flowmusic",
  "title": "Durchhalten",
  "lyrics": "[Verse 1]\nAuch die längste Nacht endet im Morgenlicht\n...",
  "sound_prompt": "energetic rock with electric guitar"
}
```

<Note>
  **Aufgabenergebnis abfragen**

  Die Songtextgenerierung ist eine asynchrone Aufgabe; nach der Übermittlung wird eine `task_id` zurückgegeben. Verwenden Sie den Endpunkt [Aufgabenstatus abrufen](./query), um Fortschritt und Ergebnis der Generierung abzufragen.
</Note>

## Beispiel für abgeschlossenes Aufgabenergebnis

**Beispiel einer Abfrageantwort** (`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..."
        }
      ]
    }
  }
}
```