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

# Renderização de Vídeo Musical

> Flow Music renderiza a música em um vídeo mp4 com base em um modelo, com suporte a três predefinições: simple / modern / player

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST \
    --url https://api.apimart.ai/v1/music/generations/videoClipFlowMusic \
    --header 'Authorization: Bearer <token>' \
    --header 'Content-Type: application/json' \
    --data '{
      "model": "flowmusic",
      "clip_id": "abc123-def456",
      "preset": "modern"
    }'
  ```

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

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

  payload = {
      "model": "flowmusic",
      "clip_id": "abc123-def456",
      "preset": "modern"
  }

  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/videoClipFlowMusic";

  const payload = {
    model: "flowmusic",
    clip_id: "abc123-def456",
    preset: "modern"
  };

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

  ```json 400 theme={null}
  {
    "error": {
      "message": "clip_id is required",
      "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"
    }
  }
  ```
</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="clip_id" type="string" required>
  clip\_id da música para a qual o vídeo será gerado, proveniente de `result.music[].clip_id` de uma tarefa concluída com sucesso
</ParamField>

<ParamField body="preset" type="string" default="simple">
  Predefinição do modelo de vídeo

  Valores possíveis:

  * `simple` - modelo minimalista
  * `modern` - modelo de estilo moderno
  * `player` - modelo em estilo de player
</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: Renderizar o vídeo musical com o modelo modern

```json theme={null}
{
  "model": "flowmusic",
  "clip_id": "abc123-def456",
  "preset": "modern"
}
```

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

  A renderização do vídeo musical é 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. O resultado fica em `result.music[0].video_url`.
</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_01KWXVD4HQEEY7B5NJ31177Q1H",
    "status": "completed",
    "progress": 100,
    "created": 1783413248,
    "completed": 1783413327,
    "actual_time": 79,
    "cost": 0.016,
    "credits_cost": 0.16,
    "result": {
      "music": [
        {
          "clip_id": "a41aade4-993e-4d28-b56f-d97e7ef7167c",
          "video_url": "https://cdn.apimart.ai/video/flowmusic_a41aade4_video_clip.mp4",
          "url": "https://cdn.apimart.ai/video/flowmusic_a41aade4_video_clip.mp4"
        }
      ]
    }
  }
}
```