docs: update readme.md
This commit is contained in:
		
							parent
							
								
									2194cbb8ec
								
							
						
					
					
						commit
						603b470a74
					
				
							
								
								
									
										70
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										70
									
								
								README.md
									
									
									
									
									
								
							@ -27,13 +27,66 @@ We have deployed an example bound to a free Suno account, so it has daily usage
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
### 1. Obtain the cookie of your app.suno.ai account
 | 
					### 1. Obtain the cookie of your app.suno.ai account
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. Head over to [app.suno.ai](https://app.suno.ai) using your browser.
 | 
				
			||||||
 | 
					2. Open up the browser console: hit `F12` or access the `Developer Tools`.
 | 
				
			||||||
 | 
					3. Navigate to the `Network tab`.
 | 
				
			||||||
 | 
					4. Give the page a quick refresh.
 | 
				
			||||||
 | 
					5. Identify the request that includes the keyword `client?\_clerk_js_version`.
 | 
				
			||||||
 | 
					6. Click on it and switch over to the `Header` tab.
 | 
				
			||||||
 | 
					7. Locate the `Cookie` section, hover your mouse over it, and copy the value of the Cookie.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### 2. Clone and deploy this project
 | 
					### 2. Clone and deploy this project
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You can choose your preferred deployment method:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#### Deploy to Vercel
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					[button]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#### Run locally
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```bash
 | 
				
			||||||
 | 
					git clone https://github.com/gcui-art/suno-api.git
 | 
				
			||||||
 | 
					cd suno-api
 | 
				
			||||||
 | 
					npm install
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### 3. Configure suno-api
 | 
					### 3. Configure suno-api
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- If deployed to Vercel, please add an environment variable `SUNO_COOKIE` in the Vercel dashboard, with the value of the cookie obtained in the first step.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					- If you’re running this locally, be sure to add the following to your `.env` file:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```bash
 | 
				
			||||||
 | 
					SUNO_COOKIE=<your-cookie>
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### 4. Run suno api
 | 
					### 4. Run suno api
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### 5. Create more freely
 | 
					- If you’ve deployed to Vercel:
 | 
				
			||||||
 | 
					  - Please click on Deploy in the Vercel dashboard and wait for the deployment to be successful.
 | 
				
			||||||
 | 
					  - Visit the `https://<vercel-assigned-domain>/api/get_limit` API for testing.
 | 
				
			||||||
 | 
					- If running locally:
 | 
				
			||||||
 | 
					  - Run `npm run dev`.
 | 
				
			||||||
 | 
					  - Visit the `http://localhost:3000/api/get_limit` API for testing.
 | 
				
			||||||
 | 
					- If the following result is returned:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```json
 | 
				
			||||||
 | 
					{
 | 
				
			||||||
 | 
					  "credits_left": 50,
 | 
				
			||||||
 | 
					  "period": "day",
 | 
				
			||||||
 | 
					  "monthly_limit": 50,
 | 
				
			||||||
 | 
					  "monthly_usage": 50
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					it means the program is running normally.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### 5. Use Suno API
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					You can check out the detailed API documentation at `https://<domain>/docs`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## API Reference
 | 
					## API Reference
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -46,16 +99,25 @@ Suno API currently mainly implements the following APIs:
 | 
				
			|||||||
- `/api/get_limit`: Get quota Info
 | 
					- `/api/get_limit`: Get quota Info
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					For more detailed documentation, please check out the demo site:
 | 
				
			||||||
 | 
					[https://.../docs](https://.../docs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Integration with Custom Agents
 | 
					## Integration with Custom Agents
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					...
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Integration with GPTs
 | 
					### Integration with GPTs
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					...
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Integration with Coze
 | 
					### Integration with Coze
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### Integration with Dify
 | 
					...
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Contribution Guidelines
 | 
					## Contribution Guidelines
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Fork the project and submit a pull request.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## License
 | 
					## License
 | 
				
			||||||
 | 
					
 | 
				
			||||||
LGPL-3.0 or later
 | 
					LGPL-3.0 or later
 | 
				
			||||||
@ -70,3 +132,7 @@ LGPL-3.0 or later
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
- Project repository: [github.com/gcui-art/suno-api](https://github.com/gcui-art/suno-api)
 | 
					- Project repository: [github.com/gcui-art/suno-api](https://github.com/gcui-art/suno-api)
 | 
				
			||||||
- Suno.ai official website: [suno.ai](https://suno.ai)
 | 
					- Suno.ai official website: [suno.ai](https://suno.ai)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Statement
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					suno-api is an unofficial open source project, intended for learning and research purposes only.
 | 
				
			||||||
 | 
				
			|||||||
							
								
								
									
										68
									
								
								README_CN.md
									
									
									
									
									
								
							
							
						
						
									
										68
									
								
								README_CN.md
									
									
									
									
									
								
							@ -26,22 +26,60 @@ Suno.ai v3 是一个令人惊叹的 AI 音乐服务,虽然官方还没有开
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
### 1. 获取你的 app.suno.ai 账号的 cookie
 | 
					### 1. 获取你的 app.suno.ai 账号的 cookie
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1. 打开浏览器的控制台:按下 F12,或者`开发者工具`
 | 
					1. 浏览器访问 [app.suno.ai](https://app.suno.ai)
 | 
				
			||||||
2. 选择`网络`标签
 | 
					2. 打开浏览器的控制台:按下 `F12` 或者`开发者工具`
 | 
				
			||||||
3. 刷新页面
 | 
					3. 选择`网络`标签
 | 
				
			||||||
4. 找到包含`client?_clerk_js_version`关键词的请求
 | 
					4. 刷新页面
 | 
				
			||||||
5. 点击并切换到 Header 标签
 | 
					5. 找到包含`client?_clerk_js_version`关键词的请求
 | 
				
			||||||
6. 找到 Cookie,鼠标复制 Cookie 的值
 | 
					6. 点击并切换到 `Header` 标签
 | 
				
			||||||
 | 
					7. 找到 `Cookie` 部分,鼠标复制 Cookie 的值
 | 
				
			||||||
 | 
					
 | 
				
			||||||

 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### 2. 克隆并部署本项目
 | 
					### 2. 克隆并部署本项目
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					你可以选择自己喜欢的部署方式:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#### 部署到 Vercel
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					[button]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#### 本地运行
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					````bash
 | 
				
			||||||
 | 
					git clone https://github.com/gcui-art/suno-api.git
 | 
				
			||||||
 | 
					cd suno-api
 | 
				
			||||||
 | 
					npm install
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### 3. 配置 suno-api
 | 
					### 3. 配置 suno-api
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### 4. 运行 suno api
 | 
					- 如果部署到了 Vercel,请在 Vercel 后台,添加环境变量 `SUNO_COOKIE`,值为第一步获取的cookie。
 | 
				
			||||||
 | 
					- 如果在本地运行,请在 .env 文件中添加:
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					SUNO_COOKIE=<your-cookie>
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### 5. 更加自由的创作
 | 
					### 4. 运行 suno api
 | 
				
			||||||
 | 
					- 如果部署到了 Vercel:
 | 
				
			||||||
 | 
					    - 请在 Vercel 后台,点击 `Deploy`,等待部署成功。
 | 
				
			||||||
 | 
					    - 访问 `https://<vercel分配的域名>/api/get_limit` API进行测试
 | 
				
			||||||
 | 
					- 如果在本地运行:
 | 
				
			||||||
 | 
					    - 请运行 `npm run dev`
 | 
				
			||||||
 | 
					    - 访问 `http://localhost:3000/api/get_limit` API进行测试
 | 
				
			||||||
 | 
					- 如果返回以下结果:
 | 
				
			||||||
 | 
					```json
 | 
				
			||||||
 | 
					{
 | 
				
			||||||
 | 
					  "credits_left": 0,
 | 
				
			||||||
 | 
					  "period": "string",
 | 
				
			||||||
 | 
					  "monthly_limit": 0,
 | 
				
			||||||
 | 
					  "monthly_usage": 0
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					则已经正常运行。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### 5. 使用Suno API
 | 
				
			||||||
 | 
					你可以在 `<域名>/docs`查看详细的API文档。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## API 说明
 | 
					## API 说明
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -52,7 +90,9 @@ Suno API 目前主要实现了以下 API:
 | 
				
			|||||||
- `/api/custom_generate`: 创建音乐(自定义模式,支持设置歌词、音乐风格、设置标题等)
 | 
					- `/api/custom_generate`: 创建音乐(自定义模式,支持设置歌词、音乐风格、设置标题等)
 | 
				
			||||||
- `/api/get`: 获取音乐
 | 
					- `/api/get`: 获取音乐
 | 
				
			||||||
- `/api/get_limit`: 获取配额信息
 | 
					- `/api/get_limit`: 获取配额信息
 | 
				
			||||||
```
 | 
					````
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					详细文档请查看演示站点: [https://.../docs](https://.../docs)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## 集成到到常见的自定义 Agent 中
 | 
					## 集成到到常见的自定义 Agent 中
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -64,10 +104,10 @@ Suno API 目前主要实现了以下 API:
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
...
 | 
					...
 | 
				
			||||||
 | 
					
 | 
				
			||||||
### 集成到 Dify
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
## 贡献指南
 | 
					## 贡献指南
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Fork 项目并提交 PR 即可。
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## 许可证
 | 
					## 许可证
 | 
				
			||||||
 | 
					
 | 
				
			||||||
LGPL-3.0 或更高版本
 | 
					LGPL-3.0 或更高版本
 | 
				
			||||||
@ -76,9 +116,13 @@ LGPL-3.0 或更高版本
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
- 联系我们:<support@gcui.art>
 | 
					- 联系我们:<support@gcui.art>
 | 
				
			||||||
- 加入我们的 [Discord](https://...)
 | 
					- 加入我们的 [Discord](https://...)
 | 
				
			||||||
- 在 twitter 上关注我们: [@gcui](https://twitter.com/gcui_art)
 | 
					- 在 twitter 上关注我们: [@gcui](https://twitter.com/...)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## 相关链接
 | 
					## 相关链接
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- 项目仓库: [github.com/gcui-art/suno-api](https://github.com/gcui-art/suno-api)
 | 
					- 项目仓库: [github.com/gcui-art/suno-api](https://github.com/gcui-art/suno-api)
 | 
				
			||||||
- Suno.ai 官网: [suno.ai](https://suno.ai)
 | 
					- Suno.ai 官网: [suno.ai](https://suno.ai)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## 声明
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					suno-api 是一个非官方的开源项目,仅供学习和研究使用。
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
		Reference in New Issue
	
	Block a user