Add Vocals Callbacks

System will call this callback when vocal generation is complete.

When you submit a vocal generation task to the Suno API using the /api/v1/generate/add-vocals endpoint, you can use the callBackUrl parameter to set a callback URL. The system will automatically push the results to your specified address when the task is completed.

This callback is triggered by the following API endpoint:

Add Vocals API — POST /api/v1/generate/add-vocals - Add vocals to uploaded music files

Callback Mechanism Overview

The callback mechanism eliminates the need to poll the API for task status. The system will proactively push task completion results to your server.

Webhook Security

To ensure the authenticity and integrity of callback requests, we strongly recommend implementing webhook signature verification. See our Webhook Verification Guide for detailed implementation steps.

Callback Timing

The system will send callback notifications in the following situations:

Text generation completed (callbackType: "text")

First audio track generation completed (callbackType: "first")

All audio tracks generation completed (callbackType: "complete")

Vocal generation task failed

Errors occurred during task processing

Callback Method

HTTP Method: POST

Content Type: application/json

Timeout Setting: 15 seconds

Callback Request Format

When the task progresses or completes, the system will send a POST request to your callBackUrl in the following format:

Complete Success Callback

First Track Success Callback

Text Generation Callback

Failure Callback

{
  "code": 200,
  "msg": "All generated successfully.",
  "data": {
    "callbackType": "complete",
    "task_id": "2fac****9f72",
    "data": [
      {
        "id": "e231****-****-****-****-****8cadc7dc",
        "audio_url": "https://example.cn/****.mp3",
        "stream_audio_url": "https://example.cn/****",
        "image_url": "https://example.cn/****.jpeg",
        "prompt": "[Verse] Night city lights shining bright",
        "model_name": "chirp-v4-5",
        "title": "Iron Man",
        "createTime": 1786343609818,
        "duration": 198.44,
        "tags": "electrifying, rock",
        "source_audio_url":"https://example.cn/****.jpeg",
        "source_image_url":"https://example.cn/****.mp3",
        "source_stream_audio_url":"https://example.cn/****"
      },
      {
        "id": "e231****-****-****-****-****8cadc7dc",
        "audio_url": "https://example.cn/****.mp3",
        "stream_audio_url": "https://example.cn/****",
        "image_url": "https://example.cn/****.jpeg",
        "prompt": "[Verse] Night city lights shining bright",
        "model_name": "chirp-v4-5",
        "title": "Iron Man",
        "createTime": 1786343609818,
        "duration": 198.44,
        "tags": "electrifying, rock",
        "source_audio_url":"https://example.cn/****.jpeg",
        "source_image_url":"https://example.cn/****.mp3",
        "source_stream_audio_url":"https://example.cn/****"
      }
    ]
  }
}

Status Code Description

Status Code	Description
200	Success - Request has been processed successfully
400	Validation Error - Lyrics contained copyrighted material
408	Rate Limited - Timeout
413	Conflict - Uploaded audio matches existing work of art
500	Server Error - An unexpected error occurred while processing the request
501	Audio generation failed
531	Server Error - Sorry, the generation failed due to an issue. Your credits have been refunded. Please try again

msg (string, required)

Status message providing detailed status description

data.callbackType (string, required)

Callback type indicating the stage of generation:

text: Text generation complete

first: First track complete

complete: All tracks complete

error: Generation failed

data.task_id (string, required)

Task ID, consistent with the taskId returned when you submitted the task

`data.data` (array)

Array of generated audio data.

`data.data[].id` (string)

Unique identifier of the audio.

`data.data[].audio_url` (string)

Audio file URL.

`data.data[].stream_audio_url` (string)

Streaming audio URL.

`data.data[].image_url` (string)

Cover image URL.

`data.data[].prompt` (string)

Generation prompt or lyrics.

`data.data[].model_name` (string)

Name of the model used.

`data.data[].title` (string)

Music title.

`data.data[].tags` (string)

Music tags.

`data.data[].createTime` (integer)

Creation time.

`data.data[].duration` (number)

Audio duration in seconds.

`data.data[].source_audio_url`（string）

Source audio file URL.

`data.data[].source_image_url`（string）

Source cover image URL.

`data.data[].source_stream_audio_url`（string）

Source streaming audio URL.

Callback Reception Examples

Here are example codes for receiving callbacks in popular programming languages:

Node.js

Python

PHP

Best Practices

Callback URL Configuration Recommendations

Use HTTPS: Ensure your callback URL uses HTTPS protocol for secure data transmission

Verify Source: Verify the legitimacy of the request source in callback processing

Idempotent Processing: The same task_id may receive multiple callbacks, ensure processing logic is idempotent

Quick Response: Callback processing should return a 200 status code as quickly as possible to avoid timeout

Asynchronous Processing: Complex business logic should be processed asynchronously to avoid blocking callback response

Stage Tracking: Differentiate between different generation stages based on callbackType and arrange business logic appropriately

Important Reminders

Callback URL must be a publicly accessible address

Server must respond within 15 seconds, otherwise it will be considered a timeout

If 3 consecutive retries fail, the system will stop sending callbacks

Please ensure the stability of callback processing logic to avoid callback failures due to exceptions

Pay attention to handling different callbackType callbacks, especially the complete type for final results

Alternative Solution

If you cannot use the callback mechanism, you can also use polling:

Poll Query Results

Use the get music details endpoint to regularly query task status. We recommend querying every 30 seconds.

Related API Endpoint#

Callback Mechanism Overview#

Callback Timing#

Callback Method#

Callback Request Format#

Status Code Description#

msg (string, required)#

data.callbackType (string, required)#

data.task_id (string, required)#

data.data (array)#

data.data[].id (string)#

data.data[].audio_url (string)#

data.data[].stream_audio_url (string)#

data.data[].image_url (string)#

data.data[].prompt (string)#

data.data[].model_name (string)#

data.data[].title (string)#

data.data[].tags (string)#

data.data[].createTime (integer)#

data.data[].duration (number)#

data.data[].source_audio_url（string）#

data.data[].source_image_url（string）#

data.data[].source_stream_audio_url（string）#

Callback Reception Examples#

Best Practices#

Alternative Solution#

Related API Endpoint

Callback Mechanism Overview

Callback Timing

Callback Method

Callback Request Format

Status Code Description

msg (string, required)

data.callbackType (string, required)

data.task_id (string, required)

`data.data` (array)

`data.data[].id` (string)

`data.data[].audio_url` (string)

`data.data[].stream_audio_url` (string)

`data.data[].image_url` (string)

`data.data[].prompt` (string)

`data.data[].model_name` (string)

`data.data[].title` (string)

`data.data[].tags` (string)

`data.data[].createTime` (integer)

`data.data[].duration` (number)

`data.data[].source_audio_url`（string）

`data.data[].source_image_url`（string）

`data.data[].source_stream_audio_url`（string）

Callback Reception Examples

Best Practices

Alternative Solution