✨ Suno AI API 🎵
✨ Python API Library for Suno AI — Create Music with Generative AI ! 🚀
📚 SunoAI API Library is an unofficial Python client for interacting with Suno AI’s music generator. This library facilitates generating music using Suno’s Chirp v3 model and includes main functions of Suno AI with a built-in music downloader. It can be deployed as a REST API using FastAPI, Local, Docker, on a PaaS provider like Heroku.
✨ Features
- Python Client 🐍: Easily interact with Suno AI.
- Song Generation 🎶: Utilize the Chirp v3 model for generating music.
- Retrieve Song Info by ID 🎵: Access detailed information about any song on Suno AI.
- Music Downloader 📥: Built-in functionality to download any music on Suno AI directly.
- REST API Deployment 🌐: Deployable as a REST API on PasS Platform , VPS or Local.
- Comprehensive Documentation 📚: Includes detailed examples and usage guides.
- Docker Support 🐳: Enables containerized deployment with Docker for flexibility.
- PaaS Deployment ☁️: Facilitates deployment on platforms like Heroku for convenient accessibility.
🏷 Prerequisites
📋 Before using the library or REST API, you must sign up on the suno.ai website and obtain your cookie as shown in this screenshot.
💡 You can find cookie from the Web Browser’s Developer Tools -> Network Tab
Click to view - Screenshot
Just right click & open Inspect. Filter : _clerk_js_version
Set this cookie as SUNO_COOKIE environment variable or initialize the library as shown below.
from suno import Suno, ModelVersions
client = Suno(
cookie='YOUR_COOKIE_HERE',
model_version=ModelVersions.CHIRP_V3_5)
💾 Installation
Install the library using pip:
pip install SunoAI
🚀 Deployment - REST API
Deploy on PasS
Set SUNO_COOKIE as an Environmental variable before deploy. - Instructions
Deploy on Local or VPS
export SUNO_COOKIE="YOUR_COOKIE_HERE"
git clone [email protected]:Malith-Rukshan/Suno-API.git
pip3 install -r requirements.txt
cd Suno-API
fastapi run api.py --port 8080
🔗 Available at : http://127.0.0.1:8080
🛠️ Usage
⚡️ Quick Start :
from suno import Suno, ModelVersions
client = Suno(
cookie='YOUR_COOKIE_HERE',
model_version=ModelVersions.CHIRP_V3_5)
# Generate a song
songs = client.generate(prompt="A serene landscape", is_custom=False, wait_audio=True)
# Download generated songs
for song in songs:
file_path = client.download(song=song)
print(f"Song downloaded to: {file_path}")
📚 Library Methods
Suno() <- Initializing
- Arguments:
- cookie (Optional[str]): Optional. The authentication cookie for the Suno API. If not provided, it will use the cookie from the environment variable SUNO_COOKIE.
- model_version (str): Optional. The model version to use for generating audio. Available models:
chirp-v3-5, chirp-v3-0, chirp-v2-0 default is chirp-v3-5. | Detailed view
generate()
- Arguments:
- prompt (str): Description or lyrics for the song.
- is_custom (bool): Determines whether to use custom lyrics (True) or a description (False).
- tags (Optional[str]): Describes desired voice type or characteristics.
- title (Optional[str]): Title for the generated music.
- make_instrumental (Optional[bool]): Generates an instrumental version if True.
- wait_audio (bool): Waits until the audio URLs are ready if True.
- model_version (Optional[str]): The model version to use for generating audio. Defaults to the initialization value if not provided.
- Returns: A list of
Clip objects containing song data with IDs.
- Example:
- By Description
clips = client.generate(
prompt="A peaceful melody reflecting a serene landscape",
is_custom=False,
wait_audio=True
)
print(clips)
- By Lyrics - Custom
clips = client.generate(
prompt="I found a love, for me\nDarling, just dive right in and follow my lead\nWell, I found a girl, beautiful and sweet\nOh, I never knew you were the someone waiting for me...",
tags="English men voice",
title="Perfect by Malith-Rukshan/Suno-API",
make_instrumental= False,
is_custom=True,
wait_audio=True
)
print(clips)
✍️ Usage Note :
- When setting
is_custom to True, ensure that the prompt parameter contains the lyrics of the song you wish to generate. Conversely, if is_custom is set to False, provide a descriptive prompt detailing the essence of the song you want.
- When
wait_audio is set to True, the request will take longer as it waits for the audio URLs to be ready. If not set, the response will return without audio_url but with audio IDs. In such cases, you’ll need to call the get_songs or get_song method after a short interval to retrieve the response with the audio_url included, once the generation process is complete.
get_songs()
set_visibility()
- Arguments:
- song_id (str): The ID of the song to update.
- is_public (bool): A string indicating whether the song should be public (True) or private (False).
- Returns (bool): Status of the public visibility of the song. True if the song is public, False if private.
- Example:
response = client.set_visibility(song_id="uuid-type-songid-1234", is_public=False)
print(response)
get_credits()
download()
📝 Available Suno AI Models:
Models provided by Suno AI to Generate music.
- CHIRP_V3_5 -
chirp-v3-5 : Newest model, better song structure, max 4 minutes.
- CHIRP_V3_0 -
chirp-v3-0 : Broad, versatile, max 2 minutes.
- CHIRP_V2_0 -
chirp-v2-0 : Vintage Suno model, max 1.3 minutes.
Example How to use:
from suno import Suno, ModelVersions
client = Suno(model_version=ModelVersions.CHIRP_V3_5)
or
from suno import Suno
client = Suno(model_version='chirp-v3-5')
📚 Library Responses
-
Clip Model:
The Clip class encapsulates the details of a music track generated by the Suno AI. Each attribute of this class provides specific information about the track:
- id (str): Unique identifier for the clip.
- video_url (str): URL of the video version of the song, if available.
- audio_url (str): URL where the audio track can be streamed or downloaded.
- image_url (str): URL of the song’s image cover.
- image_large_url (str): URL of a larger version of the song’s image cover.
- is_video_pending (bool): Indicates whether the video for the song is still processing.
- major_model_version (str): The major version of the model used to generate the song.
- model_name (str): Name of the model used to generate the track.
- metadata (ClipMetadata): Additional metadata related to the clip including tags, prompts, and other information.
- is_liked (bool): Indicates whether the song has been liked by the user.
- user_id (str): User ID of the person who created or requested the song.
- display_name (str): Display name of the user associated with the song.
- handle (str): User’s handle or username.
- is_handle_updated (bool): Specifies whether the user’s handle has been updated.
- is_trashed (bool): Indicates if the clip has been marked as trashed.
- reaction (dict): Reactions to the song from users, if any.
- created_at (str): Timestamp indicating when the song was created.
- status (str): Current status of the song (e.g., processing, completed).
- title (str): Title of the song.
- play_count (int): How many times the song has been played.
- upvote_count (int): Number of upvotes the song has received.
- is_public (bool): Indicates whether the song is publicly accessible.
-
CreditsInfo Model:
The CreditsInfo class provides information about the user’s credit balance and usage within the Suno AI system.
- credits_left (int): The number of credits remaining for the user.
- period (int): The current billing period for the credits, represented in some form of date or timeframe.
- monthly_limit (int): The total number of credits allocated to the user for the current month.
- monthly_usage (int): The amount of credits used by the user during the current month.
🌐 REST API Usage
1. Generate Music
POST /generate
-
Request Body:
{
"prompt": "A serene melody about the ocean",
"is_custom": false,
"tags": "relaxing, instrumental",
"title": "Ocean Waves",
"make_instrumental": true,
"model_version": "chirp-v3-5",
"wait_audio": true
}
-
Response:
Click to view
[
{
"id": "124b735f-7fb0-42b9-8b35-761aed65a7f6",
"video_url": "",
"audio_url": "https://audiopipe.suno.ai/item_id=124b735f-7fb0-42b9-8b35-761aed65a7f6",
"image_url": "https://cdn1.suno.aiimage_124b735f-7fb0-42b9-8b35-761aed65a7f6.png",
"image_large_url": "https://cdn1.suno.aiimage_large_124b735f-7fb0-42b9-8b35-761aed65a7f.png",
"is_video_pending": False,
"major_model_version": "v3",
"model_name": "chirp-v3",
"metadata": {
"tags": "English men voice",
"prompt": "I found a love, for me\nDarling,just dive right in and follow mylead\nWell, I found a girl, beautiful andsweet\nOh, I never knew you were thesomeone waiting for me\n\n′Cause we werejust kids when we fell in love\nNot knowingwhat it was\nI will not give you up thistime\nBut darling, just kiss me slow\nYourheart is all I own\nAnd in your eyes,you're holding mine\n\nBaby, I′m dancing inthe dark\nWith you between myarms\nBarefoot on the grass\nListening toour favourite song\nWhen you said youlooked a mess\nI whispered underneath mybreath\nBut you heard it\nDarling, you lookperfect tonight",
"gpt_description_prompt": None,
"audio_prompt_id": None,
"history": None,
"concat_history": None,
"type": "gen",
"duration": None,
"refund_credits": None,
"stream": True,
"error_type": None,
"error_message": None
},
"is_liked": False,
"user_id":"2340653f-32cb-4343-artb-09203ty749e9",
"display_name": "Snonymous",
"handle": "anonymous",
"is_handle_updated": False,
"is_trashed": False,
"reaction": None,
"created_at": "2024-05-05T11:54:09.356Z",
"status": "streaming",
"title": "Perfect by Malith-Rukshan/Suno-API",
"play_count": 0,
"upvote_count": 0,
"is_public": False
}
]
2. Retrieve Songs
POST /songs
3. Get a Specific Song
POST /get_song
POST /set_visibility
4. Retrieve Credit Information
GET /credits
According to Suno.ai Each song generation consumes 5 credits, thus a total of 10 credits is necessary for each successful call.
🤝 Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
🎯 Credits and Other
All content and music generated through this library are credited to Suno AI. This unofficial API provides a convenient way to interact with Suno AI’s services but does not claim any ownership or rights over the music generated. Please respect the terms of service of Suno AI when using their platform ❤️.
This library is intended primarily for educational and development purposes. It aims to enhance and simplify access to Suno AI’s music generation capabilities. If you enjoy the music generated, consider supporting Suno AI directly.
Logo Credit : @rejaul43
⚖️ License
This project is distributed under the MIT License. This license allows everyone to use, modify, and redistribute the code. However, it comes with no warranties regarding its functionality. For more details, see the LICENSE file in the repository.
🌟 Support and Community
If you found this project helpful, don’t forget to give it a ⭐ on GitHub. This helps others find and use the project too! 🫶
💰 Support Me
Join our Telegram channels,
If you have any questions, feedback, or just want to say hi, you can reach out to me:
🧑💻 Built with 💖 by Single Developers </>
评论