diff --git a/README.md b/README.md index c403366..cd0b145 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,71 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +# Suno AI API + +[English](./README.md) | [简体中文](./README_CN.md) + +Use API to call the music generation service of Suno.ai and easily integrate it into agents like GPTs. + +## Introduction + +Suno.ai v3 is an amazing AI music service. Although the official API is not yet available, we couldn't wait to integrate its capabilities somewhere. + +We discovered that some users have similar needs, so we decided to open-source this project, hoping you'll like it. + +## Features + +- Perfectly implements the creation API from app.suno.ai +- Supports Custom Mode +- One-click deployment to Vercel +- In addition to the standard API, it also adapts to the API Schema of Agent platforms like GPTs and Coze, so you can use it as a tool/plugin/Action for LLMs and integrate it into any AI Agent. +- Permissive open-source license, allowing you to freely integrate and modify. + +## Demo + +We have deployed an example bound to a free Suno account, so it has daily usage limits, but you can see how it runs: + +https://... ## Getting Started -First, run the development server: +### 1. Obtain the cookie of your app.suno.ai account + +### 2. Clone and deploy this project + +### 3. Configure suno-api + +### 4. Run suno api + +### 5. Create more freely + +## API Reference + +Suno API currently mainly implements the following APIs: ```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev +- `/api/create`: Create music +- `/api/get`: Get music ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +## Integration with Common Agents -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +### Integration with GPTs -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +### Integration with Coze -## Learn More +### Integration with Dify -To learn more about Next.js, take a look at the following resources: +## Contribution Guidelines -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +## License -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +LGPL-3.0 or later -## Deploy on Vercel +## Contact Us -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. +- Contact us: +- Join our [Discord](https://...) +- Follow us on Twitter: [@gcui](https://twitter.com/gcui_art) -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +## Related Links + +- Project repository: [github.com/gcui-art/suno-api](https://github.com/gcui-art/suno-api) +- Suno.ai official website: [suno.ai](https://suno.ai) diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..5755491 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,73 @@ +# Suno AI API + +[English](./README.md) | [简体中文](./README_CN.md) + +Use API to call the music generation service of suno.ai, and easily integrate it into agents like GPTs. + +## 简介 + +Suno.ai v3 是一个令人惊叹的 AI 音乐服务，虽然官方还没有开放 API，但我们已经迫不及待的想在某些地方集成它的能力。 +我们发现有一些用户也有类似需求，于是我们将这个项目开源了，希望你们喜欢。 + +## Features + +- 完美的实现了 app.suno.ai 中的创作 API +- 支持 Custom Mode +- 一键部署到 vercel +- 除了标准 API，还适配了 GPTs、coze 等 Agent 平台的 API Schema，所以你可以把它当做一个 LLM 的工具/插件/Action，集成到任意 AI Agent 中。 +- 宽松的开源协议，你可以随意的集成和修改。 + +## Demo + +我们部署了一个示例，绑定了一个免费的 suno 账号，所以它每天有使用限制，但你可以看到它运行起来的样子： +https://... + +## 如何开始使用？ + +### 1. 获取你的 app.suno.ai 账号的 cookie + +### 2. 克隆并部署本项目 + +### 3. 配置 suno-api + +### 4. 运行 suno api + +### 5. 更加自由的创作 + +## API 说明 + +Suno API 目前主要实现了以下 API: + +```bash +- `/api/create`: 创建音乐 +- `/api/get`: 获取音乐 +``` + +## 集成到你的常见 Agent 中 + +### 集成到 GPTs + +... + +### 集成到 coze + +... + +### 集成到 Dify + +## 贡献指南 + +## 许可证 + +LGPL-3.0 或更高版本 + +## 联系方式 + +- 联系我们： +- 加入我们的 [Discord](https://...) +- 在 twitter 上关注我们: [@gcui](https://twitter.com/gcui_art) + +## 相关链接 + +- 项目仓库: [github.com/gcui-art/suno-api](https://github.com/gcui-art/suno-api) +- Suno.ai 官网: [suno.ai](https://suno.ai) diff --git a/package.json b/package.json index 3df8821..919ed28 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,11 @@ { "name": "suno-api", + "description": "Use API to call the music generation service of suno.ai, and easily integrate it into agents like GPTs.", + "author": { + "name": "gcui.art", + "url": "https://github.com/gcui-art/" + }, + "license": "LGPL-3.0-or-later", "version": "0.1.0", "private": true, "scripts": { diff --git a/src/app/favicon.ico b/src/app/favicon.ico index 718d6fe..673a495 100644 Binary files a/src/app/favicon.ico and b/src/app/favicon.ico differ diff --git a/src/app/layout.tsx b/src/app/layout.tsx index 3314e47..b844fb3 100644 --- a/src/app/layout.tsx +++ b/src/app/layout.tsx @@ -5,8 +5,10 @@ import "./globals.css"; const inter = Inter({ subsets: ["latin"] }); export const metadata: Metadata = { - title: "Create Next App", - description: "Generated by create next app", + title: "suno api", + description: "Use API to call the music generation service of suno.ai", + keywords: ["suno", "suno.ai", "api", "music", "generation", "ai"], + creator: "@gcui.art", }; export default function RootLayout({ diff --git a/src/app/page.tsx b/src/app/page.tsx index b81507d..3fac907 100644 --- a/src/app/page.tsx +++ b/src/app/page.tsx @@ -5,8 +5,7 @@ export default function Home() {

- Get started by editing  - src/app/page.tsx + Suno API

By{" "} - Vercel Logo + + gcui.art +
-
- Next.js Logo +
+

+ Easily integrate Suno AI into your GPTs and other agents. +

+