Download Audio

curl --request POST \
  --url https://api.apimart.ai/v1/music/generations/downloadAudioFlowMusic \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "flowmusic",
    "clip_id": "abc123-def456",
    "format": "wav"
  }'

import requests

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

payload = {
    "model": "flowmusic",
    "clip_id": "abc123-def456",
    "format": "wav"
}

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

const payload = {
  model: "flowmusic",
  clip_id: "abc123-def456",
  format: "wav"
};

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_01KWXVD3FPYYQPJ2N87XXE5NQG"
    }
  ]
}

{
  "error": {
    "message": "format must be one of: wav, mp3",
    "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"
  }
}

POST

music

generations

downloadAudioFlowMusic

curl --request POST \
  --url https://api.apimart.ai/v1/music/generations/downloadAudioFlowMusic \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "flowmusic",
    "clip_id": "abc123-def456",
    "format": "wav"
  }'

import requests

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

payload = {
    "model": "flowmusic",
    "clip_id": "abc123-def456",
    "format": "wav"
}

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

const payload = {
  model: "flowmusic",
  clip_id: "abc123-def456",
  format: "wav"
};

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_01KWXVD3FPYYQPJ2N87XXE5NQG"
    }
  ]
}

{
  "error": {
    "message": "format must be one of: wav, mp3",
    "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/downloadAudioFlowMusic \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "flowmusic",
    "clip_id": "abc123-def456",
    "format": "wav"
  }'

import requests

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

payload = {
    "model": "flowmusic",
    "clip_id": "abc123-def456",
    "format": "wav"
}

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

const payload = {
  model: "flowmusic",
  clip_id: "abc123-def456",
  format: "wav"
};

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_01KWXVD3FPYYQPJ2N87XXE5NQG"
    }
  ]
}

{
  "error": {
    "message": "format must be one of: wav, mp3",
    "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

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

string

required

Model name, must be "flowmusic" (case-insensitive)

string

required

clip_id of the music to download, from a successful task’s result.music[].clip_id

string

required

Download formatOptions:

mp3 - Lossy compression, smaller file size
wav - Lossless, suitable for post-production

Response

integer

Response status code, 200 on success

array

Array of returned data

Show Array elements

string

Task status, submitted upon initial submission

string

Unique task identifier, used to query task status and results

Use Cases

Scenario 1: Export lossless wav

{
  "model": "flowmusic",
  "clip_id": "abc123-def456",
  "format": "wav"
}

Query Task ResultsAudio download 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 always in result.music[0].audio_url (url has the same value); the format / mime_type fields indicate the actual format.

Completed Task Result Example

Query response example (GET /v1/music/tasks/{task_id}):

{
  "code": 200,
  "data": {
    "id": "task_01KWXVD3FPYYQPJ2N87XXE5NQG",
    "status": "completed",
    "progress": 100,
    "created": 1783413247,
    "completed": 1783413296,
    "actual_time": 49,
    "cost": 0.016,
    "credits_cost": 0.16,
    "result": {
      "music": [
        {
          "clip_id": "a41aade4-993e-4d28-b56f-d97e7ef7167c",
          "format": "wav",
          "mime_type": "audio/wav",
          "size_bytes": 34900726,
          "audio_url": "https://cdn.apimart.ai/audio/flowmusic_a41aade4_download_audio.wav",
          "url": "https://cdn.apimart.ai/audio/flowmusic_a41aade4_download_audio.wav"
        }
      ]
    }
  }
}

Upload Audio Music Video Rendering

Overview

Text Series

Image Series

Video Series

Audio Series

Moderation Series

Upload Management

Task Management

Account Management

Authentication

Request Parameters

Response

Use Cases

Scenario 1: Export lossless wav

Completed Task Result Example

​Authentication

​Request Parameters

​Response

​Use Cases

​Scenario 1: Export lossless wav

​Completed Task Result Example

Authentication

Request Parameters

Response

Use Cases

Scenario 1: Export lossless wav

Completed Task Result Example