ProductName Introduction
Suno AI API is an open-source project that enables you to set up your own Suno AI API. This project was created due to the amazing capabilities of Suno.ai v3, an AI music service. Although the official API is not yet available, the developers of suno-api couldn't wait to integrate its capabilities into their projects. They discovered that some users have similar needs, so they decided to open-source this project, hoping others would find it useful. The project is frequently updated, and users are encouraged to star it on Github: github.com/gcui-art/suno-api⭐.
ProductName Features
The suno-api project perfectly implements the creation API from app.suno.ai and is compatible with the format of OpenAI’s /v1/chat/completions API. Here are some of its notable features:
- Automatically Keep Account Active: The API automatically keeps your account active, ensuring seamless usage.
- Supports Custom Mode: You can generate music with custom lyrics, music style, title, etc.
- One-click Deployment to Vercel: Easy deployment to Vercel for quick usage.
- Compatibility with Agent Platforms: Adapts to the API Schema of Agent platforms like GPTs and Coze, allowing integration into any AI Agent.
- Permissive Open-Source License: Freely integrate and modify the API as needed.
How to Get Started with ProductName
To get started with suno-api, follow these steps:
- Obtain the cookie of your app.suno.ai account: Follow the instructions provided on the project's page to obtain the necessary cookie.
- Clone and Deploy the Project: Choose your preferred deployment method, either deploying to Vercel or running locally.
- Configure
suno-api: Set the environment variableSUNO_COOKIEwith the value of the cookie obtained in the first step. - Run
suno-api: Follow the instructions based on your deployment method and test the API to ensure it's running normally. - Use Suno API: Check out the detailed API documentation at suno.gcui.art/docs for more information on how to use the API.
ProductName API Reference
Suno API currently implements several APIs, including:
/api/generate: Generate music./v1/chat/completions: Generate music in a format that works with OpenAI’s API./api/custom_generate: Generate music (Custom Mode)./api/generate_lyrics: Generate lyrics based on prompt./api/get: Get music list./api/get?ids=: Get music info by id./api/get_limit: Get quota info./api/extend_audio: Extend audio length.
For more detailed documentation, visit the demo site at suno.gcui.art/docs.
ProductName Usage Scenarios
The suno-api can be used in various scenarios, such as integrating AI music generation into web applications, creating custom music-based projects, or developing smart AI agents that utilize music generation as part of their functionality.
ProductName Contribution Guide
Contributions to the suno-api project are welcome. Users can report issues, request features, or submit pull requests through the project's GitHub repository. The project maintainers are actively looking for community feedback to improve and expand the API's capabilities.
ProductName Frequently Asked Questions (FAQs)
What is the suno-api project?
suno-api is an open-source project that allows users to set up their own Suno AI API, enabling them to integrate AI music generation into their projects.
How can I contribute to the suno-api project?
You can contribute to the project by reporting issues, requesting features, or submitting pull requests through the project's GitHub repository.
Is there a limit to how much I can use the API?
Yes, there are usage limits. You can check your quota info using the /api/get_limit API.
Can I use the API with agent platforms like GPTs and Coze?
Yes, the API adapts to the API Schema of Agent platforms, allowing you to use it as a tool/plugin/Action for LLMs and integrate it into any AI Agent.
Where can I find detailed documentation for the API?
Detailed documentation for the API can be found at suno.gcui.art/docs.
