Callback Interface

POST

/your-partner-domain.com/instrumental/callback

A callback interface developed by yourself, used for completion callbacks, If the request is successful, please return: success. Instrumental generation will have two callbacks: the first for mp3 audio, the second for wav audio.

Request

Body Params application/json

instrumentals

array [object {13}]

required

List of item information

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"

model

string

optional

Generated model

title

string

optional

Title

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)

style

string

optional

Style

event

string

optional

Callback event 1. audio_complete 2. wav_complete 3. lrcsections_complete

Example

{
    "instrumentals": [
        {
            "audio_hi_status": "sub_succeeded",
            "audio_hi_url": "https://*****",
            "audio_url": "https://*******",
            "created_at": 1747278096,
            "duration": 262,
            "event": "wav_complete",
            "finished_at": 1747278158,
            "item_id": "123",
            "model": "TemPolor i3.5",
            "prompt": "Genre: Electronic Dance Music (EDM), House, Techno  Style: Instrumental, Beat-driven, Club-oriented  Mood: Energetic, Vibrant, Hypnotic  Tempo: Typically ranges from 120 to 130 BPM (Beats Per Minute)  Structure: Build-ups, Drops, Breakdowns  Instruments/Sounds: Synthesizers, Drum Machines, Basslines, Hi-hats, Pads  Purpose: Ideal for clubs, parties, workout sessions, or background ambiance  Vibe: Uplifting, Groovy, Futuristic",
            "status": "succeeded",
            "style": "electronic,house,techno",
            "title": "Neon Pulse Drive"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/your-partner-domain.com/instrumental/callback' \
--header 'Content-Type: application/json' \
--data-raw '{
    "instrumentals": [
        {
            "audio_hi_status": "sub_succeeded",
            "audio_hi_url": "https://*****",
            "audio_url": "https://*******",
            "created_at": 1747278096,
            "duration": 262,
            "event": "wav_complete",
            "finished_at": 1747278158,
            "item_id": "123",
            "model": "TemPolor i3.5",
            "prompt": "Genre: Electronic Dance Music (EDM), House, Techno  Style: Instrumental, Beat-driven, Club-oriented  Mood: Energetic, Vibrant, Hypnotic  Tempo: Typically ranges from 120 to 130 BPM (Beats Per Minute)  Structure: Build-ups, Drops, Breakdowns  Instruments/Sounds: Synthesizers, Drum Machines, Basslines, Hi-hats, Pads  Purpose: Ideal for clubs, parties, workout sessions, or background ambiance  Vibe: Uplifting, Groovy, Futuristic",
            "status": "succeeded",
            "style": "electronic,house,techno",
            "title": "Neon Pulse Drive"
        }
    ]
}'

Responses

🟢200OK

*/*

Body

string

optional

Example

success

Instrumental Extension

Query Task Status