Callback Interface

A callback interface developed by yourself, used for completion callbacks, If the request is successful, please return: success. Music generation will have three callbacks: the first for mp3 audio, the second for wav audio, and the third for lyrics data.

Request

Body Params application/json

songs

array [object {15}]

required

item_id

string

optional

Item ID

status

string

optional

"Status
running - Generating
main_succeeded - Main function succeeded
failed - Main function failed
succeeded - Succeeded
part_failed - Partial sub-function failed"

audio_hi_status

string

optional

"Lossless audio generation status
waiting - Waiting
running - Generating
sub_succeeded - Succeeded
sub_failed - Failed"

lyrics_sections_status

string

optional

"Lyrics alignment generation status
waiting - Waiting
running - Generating
sub_succeeded - Succeeded
sub_failed - Failed"

event

null

optional

Callback event 1. audio_complete 2. wav_complete 3. lrcsections_complete

model

string

optional

Generated model

title

string

optional

Title

style

string

optional

Style

prompt

string

optional

Music description

duration

integer

optional

Duration - seconds

created_at

integer

optional

Timestamp of task creation (in seconds)

finished_at

integer

optional

Timestamp of task completion (in seconds), time when the main function was completed

audio_url

string

optional

Item audio URL mp3 (valid for 3 days)

audio_hi_url

string

optional

Lossless audio wav (valid for 3 days)

lyrics_sections

array [object {3}]

optional

Lyrics alignment information

Example

{
    "songs": [
        {
            "item_id": "123",
            "status": "succeeded",
            "audio_hi_status": "sub_succeeded",
            "lyrics_sections_status": "sub_succeeded",
            "event": "audio_complete",
            "model": "TemPolor v3",
            "title": "Owl's Moonlit Waltz",
            "style": "Pop",
            "prompt": "A Song About an Owl’s Moonlit Dance in Happy Style",
            "duration": 96,
            "created_at": 1747207597,
            "finished_at": 1747207721,
            "audio_url": "https://*******",
            "audio_hi_url": "https://******",
            "lyrics_sections": [
                {
                    "start": 0.76,
                    "end": 0.78,
                    "text": "[intro]"
                },
                {
                    "start": 0.9,
                    "end": 0.92,
                    "text": "\n[verse]"
                },
                {
                    "start": 16.761,
                    "end": 19.75,
                    "text": "Under silver beams it flies"
                },
                {
                    "start": 20.361,
                    "end": 23.97,
                    "text": "Graceful wings that paint the skies"
                },
                {
                    "start": 24.502,
                    "end": 28.612,
                    "text": "Whispers soft beneath the trees"
                },
                {
                    "start": 28.662,
                    "end": 32.102,
                    "text": "Night unfolds with gentle breeze"
                },
                {
                    "start": 32.462,
                    "end": 32.482,
                    "text": "\n[chorus]"
                },
                {
                    "start": 33.342,
                    "end": 36.97,
                    "text": "Moonlight guides the silent flight"
                },
                {
                    "start": 37.622,
                    "end": 41.123,
                    "text": "Owls dance in pure delight"
                },
                {
                    "start": 41.623,
                    "end": 45.57,
                    "text": "Stars above with shining eyes"
                },
                {
                    "start": 45.863,
                    "end": 49.343,
                    "text": "Joy unfolds before sunrise"
                },
                {
                    "start": 49.823,
                    "end": 49.843,
                    "text": "\n[chorus]"
                },
                {
                    "start": 50.043,
                    "end": 53.21,
                    "text": "Moonlight guides the silent flight"
                },
                {
                    "start": 53.843,
                    "end": 57.48,
                    "text": "Owls dance in pure delight"
                },
                {
                    "start": 58.304,
                    "end": 61.004,
                    "text": "Stars above with shining eyes"
                },
                {
                    "start": 61.024,
                    "end": 61.964,
                    "text": "Joy unfolds before sunrise"
                },
                {
                    "start": 61.984,
                    "end": 62.004,
                    "text": "\n[verse]"
                },
                {
                    "start": 62.024,
                    "end": 63.294,
                    "text": "Echoes laugh through shadowed glade"
                },
                {
                    "start": 63.344,
                    "end": 64.244,
                    "text": "Every step a note is played"
                },
                {
                    "start": 64.264,
                    "end": 65.244,
                    "text": "Twilight wraps the forest deep"
                },
                {
                    "start": 65.264,
                    "end": 66.644,
                    "text": "Hearts awake from quiet sleep"
                },
                {
                    "start": 66.684,
                    "end": 66.704,
                    "text": "\n[chorus]"
                },
                {
                    "start": 66.744,
                    "end": 70.324,
                    "text": "Moonlight guides the silent flight"
                },
                {
                    "start": 71.045,
                    "end": 74.61,
                    "text": "Owls dance in pure delight"
                },
                {
                    "start": 75.025,
                    "end": 78.765,
                    "text": "Stars above with shining eyes"
                },
                {
                    "start": 79.305,
                    "end": 82.405,
                    "text": "Joy unfolds before sunrise"
                },
                {
                    "start": 92.366,
                    "end": 96.026,
                    "text": "\n[inst]"
                }
            ]
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/your-partner-domain.com/song/callback' \
--header 'Content-Type: application/json' \
--data-raw '{
    "songs": [
        {
            "item_id": "123",
            "status": "succeeded",
            "audio_hi_status": "sub_succeeded",
            "lyrics_sections_status": "sub_succeeded",
            "event": "audio_complete",
            "model": "TemPolor v3",
            "title": "Owl'\''s Moonlit Waltz",
            "style": "Pop",
            "prompt": "A Song About an Owl’s Moonlit Dance in Happy Style",
            "duration": 96,
            "created_at": 1747207597,
            "finished_at": 1747207721,
            "audio_url": "https://*******",
            "audio_hi_url": "https://******",
            "lyrics_sections": [
                {
                    "start": 0.76,
                    "end": 0.78,
                    "text": "[intro]"
                },
                {
                    "start": 0.9,
                    "end": 0.92,
                    "text": "\n[verse]"
                },
                {
                    "start": 16.761,
                    "end": 19.75,
                    "text": "Under silver beams it flies"
                },
                {
                    "start": 20.361,
                    "end": 23.97,
                    "text": "Graceful wings that paint the skies"
                },
                {
                    "start": 24.502,
                    "end": 28.612,
                    "text": "Whispers soft beneath the trees"
                },
                {
                    "start": 28.662,
                    "end": 32.102,
                    "text": "Night unfolds with gentle breeze"
                },
                {
                    "start": 32.462,
                    "end": 32.482,
                    "text": "\n[chorus]"
                },
                {
                    "start": 33.342,
                    "end": 36.97,
                    "text": "Moonlight guides the silent flight"
                },
                {
                    "start": 37.622,
                    "end": 41.123,
                    "text": "Owls dance in pure delight"
                },
                {
                    "start": 41.623,
                    "end": 45.57,
                    "text": "Stars above with shining eyes"
                },
                {
                    "start": 45.863,
                    "end": 49.343,
                    "text": "Joy unfolds before sunrise"
                },
                {
                    "start": 49.823,
                    "end": 49.843,
                    "text": "\n[chorus]"
                },
                {
                    "start": 50.043,
                    "end": 53.21,
                    "text": "Moonlight guides the silent flight"
                },
                {
                    "start": 53.843,
                    "end": 57.48,
                    "text": "Owls dance in pure delight"
                },
                {
                    "start": 58.304,
                    "end": 61.004,
                    "text": "Stars above with shining eyes"
                },
                {
                    "start": 61.024,
                    "end": 61.964,
                    "text": "Joy unfolds before sunrise"
                },
                {
                    "start": 61.984,
                    "end": 62.004,
                    "text": "\n[verse]"
                },
                {
                    "start": 62.024,
                    "end": 63.294,
                    "text": "Echoes laugh through shadowed glade"
                },
                {
                    "start": 63.344,
                    "end": 64.244,
                    "text": "Every step a note is played"
                },
                {
                    "start": 64.264,
                    "end": 65.244,
                    "text": "Twilight wraps the forest deep"
                },
                {
                    "start": 65.264,
                    "end": 66.644,
                    "text": "Hearts awake from quiet sleep"
                },
                {
                    "start": 66.684,
                    "end": 66.704,
                    "text": "\n[chorus]"
                },
                {
                    "start": 66.744,
                    "end": 70.324,
                    "text": "Moonlight guides the silent flight"
                },
                {
                    "start": 71.045,
                    "end": 74.61,
                    "text": "Owls dance in pure delight"
                },
                {
                    "start": 75.025,
                    "end": 78.765,
                    "text": "Stars above with shining eyes"
                },
                {
                    "start": 79.305,
                    "end": 82.405,
                    "text": "Joy unfolds before sunrise"
                },
                {
                    "start": 92.366,
                    "end": 96.026,
                    "text": "\n[inst]"
                }
            ]
        }
    ]
}'

Request

Request samples

Responses