Skip to main content
GET
/
api
/
v1
/
vocal-removal
/
record-info
Get Vocal Separation Details
curl --request GET \
  --url https://api.api.box/api/v1/vocal-removal/record-info \
  --header 'Authorization: Bearer <token>'
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "3e63b4cc88d52611159371f6af5571e7",
    "musicId": "376c687e-d439-42c1-b1e4-bcb43b095ec2",
    "callbackUrl": "https://57312fc2e366.ngrok-free.app/api/v1/vocal-removal/test",
    "musicIndex": 0,
    "completeTime": 1753782937000,
    "response": {
      "originUrl": null,
      "instrumentalUrl": "https://file.aiquickdraw.com/s/d92a13bf-c6f4-4ade-bb47-f69738435528_Instrumental.mp3",
      "vocalUrl": "https://file.aiquickdraw.com/s/3d7021c9-fa8b-4eda-91d1-3b9297ddb172_Vocals.mp3",
      "backingVocalsUrl": null,
      "drumsUrl": null,
      "bassUrl": null,
      "guitarUrl": null,
      "keyboardUrl": null,
      "percussionUrl": null,
      "stringsUrl": null,
      "synthUrl": null,
      "fxUrl": null,
      "brassUrl": null,
      "woodwindsUrl": null
    },
    "successFlag": "SUCCESS",
    "createTime": 1753782854000,
    "errorCode": null,
    "errorMessage": null
  }
}

​
Status Descriptions

  • PENDING: Task is waiting to be processed
  • SUCCESS: Vocal separation completed successfully
  • CREATE_TASK_FAILED: Failed to create the separation task
  • GENERATE_AUDIO_FAILED: Failed to perform vocal separation
  • CALLBACK_EXCEPTION: Error occurred during callback

​
Separation Type Description

Based on the type parameter specified when submitting the task, the query details return different fields:

​
separate_vocal Type Results

When using separate_vocal type for separation, the response contains the following fields:
  1. originUrl: Original mixed track
  2. instrumentalUrl: Instrumental track without vocals
  3. vocalUrl: Isolated vocals only track
  4. Other instrument fields are null

​
split_stem Type Results

When using split_stem type for separation, the response contains the following fields:
  1. originUrl: Original mixed track
  2. vocalUrl: Isolated vocals only track
  3. backingVocalsUrl: Isolated backing vocals track
  4. drumsUrl: Isolated drums track
  5. bassUrl: Isolated bass track
  6. guitarUrl: Isolated guitar track
  7. keyboardUrl: Isolated keyboard track
  8. percussionUrl: Isolated percussion instruments track
  9. stringsUrl: Isolated string instruments track
  10. synthUrl: Isolated synthesizer track
  11. fxUrl: Isolated sound effects track
  12. brassUrl: Isolated brass instruments track
  13. woodwindsUrl: Isolated woodwind instruments track
  14. instrumentalUrl: Instrumental track (is null in split_stem type)

​
Developer Notes

  • Use this endpoint to check separation status instead of waiting for callbacks
  • When status is SUCCESS, the response includes multiple download URLs
  • Different separation types return different numbers of audio files
  • separate_vocal type returns instrumentalUrl and vocalUrl fields, other instrument fields are null
  • split_stem type returns detailed instrument separation fields, instrumentalUrl is null
  • Task creation and completion times are included in the response
  • All audio file URLs are retained for 14 days, download and save them promptly

Authorizations

​
Authorization
string
header
required

🔑 API Authentication

All endpoints require authentication using Bearer Token.

Get API Key

  1. Visit the API Key Management Page to obtain your API Key

Usage

Add to request headers:

Authorization: Bearer YOUR_API_KEY

⚠️ Note:

  • Keep your API Key secure and do not share it with others
  • If you suspect your API Key has been compromised, reset it immediately from the management page

Query Parameters

​
taskId
string
required

The task ID returned from the Separate Vocals from Music endpoint. Used to retrieve detailed information about a specific vocal separation task, including download URLs for all audio components (original, vocals, instrumental, drums, bass, guitar, piano).

Response

Request successful

​
code
enum<integer>

Status Codes

  • ✅ 200 - Request successful
  • ⚠️ 400 - Invalid parameters
  • ⚠️ 401 - Unauthorized access
  • ⚠️ 404 - Invalid request method or path
  • ⚠️ 405 - Rate limit exceeded
  • ⚠️ 413 - Theme or prompt too long
  • ⚠️ 429 - Insufficient credits
  • ⚠️ 430 - Your call frequency is too high. Please try again later.
  • ⚠️ 455 - System maintenance
  • ❌ 500 - Server error
Available options:
200,
400,
401,
404,
405,
413,
429,
430,
455,
500
Example:

200

​
msg
string

Error message when code != 200

Example:

"success"

​
data
object