Skip to main content
POST
/
v1
/
music
/
generations
/
videoClipFlowMusic
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"
  }'

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())

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));

{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01KWXVD4HQEEY7B5NJ31177Q1H"
    }
  ]
}

{
  "error": {
    "message": "clip_id is required",
    "type": "invalid_request",
    "param": "",
    "code": "invalid_request"
  }
}

{
  "error": {
    "message": "Insufficient balance",
    "type": "invalid_request",
    "param": "",
    "code": "quota_not_enough"
  }
}

{
  "error": {
    "message": "Current group capacity is saturated, please retry later",
    "type": "rate_limit_error",
    "param": "",
    "code": "rate_limit_error"
  }
}

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

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())

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));

{
  "code": 200,
  "data": [
    {
      "status": "submitted",
      "task_id": "task_01KWXVD4HQEEY7B5NJ31177Q1H"
    }
  ]
}

{
  "error": {
    "message": "clip_id is required",
    "type": "invalid_request",
    "param": "",
    "code": "invalid_request"
  }
}

{
  "error": {
    "message": "Insufficient balance",
    "type": "invalid_request",
    "param": "",
    "code": "quota_not_enough"
  }
}

{
  "error": {
    "message": "Current group capacity is saturated, please retry later",
    "type": "rate_limit_error",
    "param": "",
    "code": "rate_limit_error"
  }
}

​
Authentication

​
Authorization
string
required
All endpoints require Bearer Token authenticationGet your API Key:Visit the API Key management page to get your API KeyAdd it to the request header:
Authorization: Bearer YOUR_API_KEY

​
Request Parameters

​
model
string
required
Model name, must be "flowmusic" (case-insensitive)
​
clip_id
string
required
clip_id of the music to generate a video for, from a successful task’s result.music[].clip_id
​
preset
string
default:"simple"
Video template presetOptions:
  • simple - Clean template
  • modern - Modern-style template
  • player - Player-style template

​
Response

​
code
integer
Response status code, 200 on success
​
data
array
Array of returned data

​
Use Cases

​
Scenario 1: Render a music video with the modern template

{
  "model": "flowmusic",
  "clip_id": "abc123-def456",
  "preset": "modern"
}
Query Task ResultsMusic video rendering is an asynchronous task; a task_id is returned after submission. Use the Get Task Status endpoint to query generation progress and results. The result is in result.music[0].video_url.

​
Completed Task Result Example

Query response example (GET /v1/music/tasks/{task_id}): 
{
  "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"
        }
      ]
    }
  }
}