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

# Gerar Letras

> Flow Music gera letras a partir de um prompt. O resultado pode ser reutilizado no campo lyrics do endpoint de geração de música

<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": "Uma música de rock sobre perseverança"
    }'
  ```

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

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

  payload = {
      "model": "flowmusic",
      "prompt": "Uma música de rock sobre perseverança"
  }

  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: "Uma música de rock sobre perseverança"
  };

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

## Autenticação

<ParamField header="Authorization" type="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://apimart.ai/keys) para obter sua API Key

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

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

## Parâmetros da Requisição

<ParamField body="model" type="string" required>
  Nome do modelo, **sempre passe `"flowmusic"`** (não diferencia maiúsculas de minúsculas)
</ParamField>

<ParamField body="prompt" type="string" required>
  Prompt para gerar as letras, **≤ 3000 caracteres**

  Recomenda-se descrever o tema, o estilo e o clima da música para obter letras mais adequadas

  Exemplo: `"Uma música de rock sobre perseverança"`
</ParamField>

## Resposta

<ResponseField name="code" type="integer">
  Código de status da resposta, 200 em caso de sucesso
</ResponseField>

<ResponseField name="data" type="array">
  Array de dados retornados

  <Expandable title="Elementos do array">
    <ResponseField name="status" type="string">
      Status da tarefa, `submitted` no envio inicial
    </ResponseField>

    <ResponseField name="task_id" type="string">
      Identificador único da tarefa, usado para consultar o status e o resultado da tarefa
    </ResponseField>
  </Expandable>
</ResponseField>

## Casos de Uso

### Cenário 1: Gerar letras por tema

```json theme={null}
{
  "model": "flowmusic",
  "prompt": "Uma música de rock sobre perseverança"
}
```

### Cenário 2: Reutilizar as letras para compor a música

Primeiro gere as letras; ao concluir, pegue o `title` e o `lyrics` de `result.lyrics[0]` e reutilize-os no endpoint [Gerar Música](./music):

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

<Note>
  **Consultar o Resultado da Tarefa**

  A geração de letras é uma tarefa assíncrona; após o envio, um `task_id` é retornado. Use o endpoint [Obter Status da Tarefa](./query) para consultar o progresso e o resultado da geração.
</Note>

## 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_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..."
        }
      ]
    }
  }
}
```