Song Extend - Suno API

Request

Header Params

x-api-key

string

required

Your API key for authorization

Body Params application/json

model

enum<string>

required

Allowed value:

music-s

task_type

enum<string>

required

Allowed value:

generate_music_custom

input

object

required

gpt_description_prompt

string

required

A plain prompt to describe the song.Only available in generate_music task type.

make_instrumental

boolean

optional

Default:

false

title

string

optional

The title of the song.Only available in generate_music_custom task type

prompt

string

required

The prompt to add lyrics into the music. Only available in generate_music_custom task type

tags

string

optional

The type of music. Only available in generate_music_custom task type

negative_tags

string

optional

Only available in generate_music_custom task type.

continue_clip_id

string

optional

The clip_id of the clip to continue from.Only available in generate_music_custom task type.

continue_at

string

optional

The continuation from the last second of the previous clip. The value 0 indicates restart from the beginning. Only available in generate_music_custom task type.

config

object

optional

webhook_config

object

optional

Webhook provides timely task notifications. Check PiAPI webhook for detail.

service_mode

enum<string>

optional

This allows users to choose whether this specific task will get processed under PAYG or HYA mode. If unspecified, then this task will get processed under whatever mode (PAYG or HYA)
the user chose on the workspace setting of your account.

public means this task will be processed under PAYG mode.

private means this task will be processed under HYA mode.

Allowed values:

publicprivate

Example

{
  "model": "music-s",
  "task_type": "generate_music",
  "input": {
    "gpt_description_prompt": "Autumn night breeze",
    "make_instrumental": true,
    "title": "curiously before while what till intent physically pfft",
    "prompt": "nulla irure",
    "tags": "asporto",
    "negative_tags": "iste",
    "continue_clip_id": "officia id est",
    "continue_at": "2025-01-26T16:27:53.468Z"
  },
  "config": {
    "webhook_config": {
      "endpoint": "",
      "secret": ""
    },
    "service_mode": ""
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.piapi.ai/api/v1/task' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "music-s",
    "task_type": "generate_music",
    "input": {
        "gpt_description_prompt": "Autumn night breeze",
        "make_instrumental": true,
        "title": "curiously before while what till intent physically pfft",
        "prompt": "nulla irure",
        "tags": "asporto",
        "negative_tags": "iste",
        "continue_clip_id": "officia id est",
        "continue_at": "2025-01-26T16:27:53.468Z"
    },
    "config": {
        "webhook_config": {
            "endpoint": "",
            "secret": ""
        },
        "service_mode": ""
    }
}'

Responses

🟢200Success

application/json

Body

code

integer

required

data

object

required

task_id

string

required

model

string

required

task_type

string

required

status

enum<string>

required

Hover on the "Completed" option and you coult see the explaintion of all status: completed/processing/pending/failed/staged

Allowed values:

CompletedProcessingPendingFailedStaged

input

object

required

output

object

required

meta

object

required

detail

null

required

logs

array [object]

required

error

object

required

message

string

required

If you get non-null error message, here are some steps you chould follow:

Check our common error message

Retry for several times

If you have retried for more than 3 times and still not work, file a ticket on Discord and our support will be with you soon.

Example

{
  "code": 200,
  "data": {
    "task_id": "d6c778aa-44cc-4a07-935d-a4c6e70755a7",
    "model": "music-s",
    "task_type": "generate_music_custom",
    "status": "pending",
    "config": {
      "service_mode": "public",
      "webhook_config": {
        "endpoint": "",
        "secret": ""
      }
    },
    "input": {},
    "output": {
      "clips": null
    },
    "meta": {},
    "detail": null,
    "logs": [],
    "error": {
      "code": 0,
      "raw_message": "",
      "message": "",
      "detail": null
    }
  },
  "message": "success"
}

[Suno] Song Extend

Request

Request samples

Responses