API Documentation

API Endpoint: https://api.apify.run/api/v1/

Header Parameters:

Note: The parameter here is api-key not api_key.

{
  "api-key": "Your API Key",
}

API1 Generate Music

Description: This interface is a custom creation mode with high flexibility. This interface only submits the music generation task, and you need to use the two returned song_id and API2 to check the results.

Path: /api/v1/generate

Method: POST

Type: application/json

Parameters:

Parameter Name	Type	Description	Remark
title	String	Music title
tags	String	Music style
prompt	String	Music creation prompt words
mv	String	Model	Default is chirp-v3-0, parameter not required
continue_at	String		Optional parameter
continue_clip_id	String		Optional parameter

Return Example:

{
 "code": 0,
 "msg": "success",
 "data": [{
  "user_id": "xxx",
  "song_id": "71540f19-d335-4938-95e7-52b3d524d17c",
  "status": "submitted",
  "title": "Happy dog Song",
  "image_large_url": null,
  "image_url": null,
  "model_name": "chirp-v3",
  "video_url": "",
  "audio_url": "",
  "meta_tags": "happy, rock",
  "meta_prompt": "A happy song about dogs",
  "meta_duration": null,
  "meta_error_msg": null,
  "meta_error_type": null
 }, {
  "user_id": "xxx",
  "song_id": "afdcb554-249d-4d67-90e3-917f7b4f8bfe",
  "status": "submitted",
  "title": "Happy dog Song",
  "image_large_url": null,
  "image_url": null,
  "model_name": "chirp-v3",
  "video_url": "",
  "audio_url": "",
  "meta_tags": "happy, rock",
  "meta_prompt": "A happy song about dogs",
  "meta_duration": null,
  "meta_error_msg": null,
  "meta_error_type": null
 }]
}

Key Parameter Description:

Parameter Name	Type	Description	Remark
title	String	Music title
status	String	Generation status
song_id	String	Song ID	Can be used to query generation results

API2 Query Generation Results

Description: This interface accepts a ids as a parameter to query the music generation status of that id.

Path: /api/v1/feeds Method: GET Type: application/json

Parameters:

Parameter Name	Type	Description	Remark
ids	String	Song ID

Return Example:

{
    "code": 0,
    "msg": "success",
    "data": {
        "user_id": "8xxx",
        "song_id": "71540f19-d335-4938-95e7-52b3d524d17c",
        "status": "complete",
        "title": "Happy dog Song",
        "image_large_url": "https://cdn1.suno.ai/image_large_71540f19-d335-4938-95e7-52b3d524d17c.png",
        "image_url": "https://cdn1.suno.ai/image_71540f19-d335-4938-95e7-52b3d524d17c.png",
        "model_name": "chirp-v3",
        "video_url": "https://cdn1.suno.ai/71540f19-d335-4938-95e7-52b3d524d17c.mp4",
        "audio_url": "https://cdn1.suno.ai/71540f19-d335-4938-95e7-52b3d524d17c.mp3",
        "meta_tags": "happy, rock",
        "meta_prompt": "A happy song about dogs",
        "meta_duration": 64,
        "meta_error_msg": null,
        "meta_error_type": null
    }
}