Skip to main content

​
Endpoint

POST /api/v1/music/add-instrumental
Asynchronous. Returns a task_id. Poll Get Task for results. Takes a vocal audio clip (uploaded via Upload Audio) and adds AI-generated instrumental music underneath it.

​
Request body

FieldTypeRequiredDescription
clip_idstringYesClip ID of the source vocal audio (from Upload Audio).
start_sfloatNoStart time in seconds of the vocal segment to use. Default 0.
end_sfloatNoEnd time in seconds of the vocal segment. Default 0 (use full clip).
mvstringNoModel version (e.g. "chirp-v3-5"). Uses default if omitted.
callback_urlstringNoWebhook URL for completion notification. See Webhooks.
retention_daysintegerNoDays to retain audio files. Default 7.

​
Response

{
  "code": 0,
  "message": "ok",
  "request_id": "req-1710000000000",
  "data": {
    "task_id": "64f3a1b2c8d9e0f1a2b3c4d5",
    "status": "queuing"
  }
}

​
Workflow

  1. Upload your vocal audio via Upload Audio → get clipId
  2. Call this endpoint with the clipId → get task_id
  3. Poll Get Task until status = "completed"
  4. Access the generated track via results[].audio_url

​
Example

# 1. Upload vocal audio
CLIP_ID=$(curl -s -X POST https://api.example.com/api/v1/music/upload \
  -H "Authorization: Bearer sk-mm-your-key" \
  -H "Content-Type: application/json" \
  -d '{"audio_url":"https://example.com/my-vocals.mp3"}' \
  | jq -r '.data.clipId')

# 2. Add instrumental
curl -X POST https://api.example.com/api/v1/music/add-instrumental \
  -H "Authorization: Bearer sk-mm-your-key" \
  -H "Content-Type: application/json" \
  -d "{
    \"clip_id\": \"$CLIP_ID\",
    \"start_s\": 0,
    \"end_s\": 30
  }"