docs: update readme.md

This commit is contained in:
blueeon 2024-03-28 20:27:24 +08:00
parent 603b470a74
commit f07c8ba7d7

View File

@ -46,7 +46,7 @@ Suno.ai v3 是一个令人惊叹的 AI 音乐服务,虽然官方还没有开
#### 本地运行
````bash
```bash
git clone https://github.com/gcui-art/suno-api.git
cd suno-api
npm install
@ -54,20 +54,23 @@ npm install
### 3. 配置 suno-api
- 如果部署到了 Vercel请在 Vercel 后台,添加环境变量 `SUNO_COOKIE`值为第一步获取的cookie。
- 如果部署到了 Vercel请在 Vercel 后台,添加环境变量 `SUNO_COOKIE`,值为第一步获取的 cookie。
- 如果在本地运行,请在 .env 文件中添加:
```
```bash
SUNO_COOKIE=<your-cookie>
```
### 4. 运行 suno api
- 如果部署到了 Vercel
- 请在 Vercel 后台,点击 `Deploy`,等待部署成功。
- 访问 `https://<vercel分配的域名>/api/get_limit` API进行测试
- 请在 Vercel 后台,点击 `Deploy`,等待部署成功。
- 访问 `https://<vercel分配的域名>/api/get_limit` API 进行测试
- 如果在本地运行:
- 请运行 `npm run dev`
- 访问 `http://localhost:3000/api/get_limit` API进行测试
- 请运行 `npm run dev`
- 访问 `http://localhost:3000/api/get_limit` API 进行测试
- 如果返回以下结果:
```json
{
"credits_left": 0,
@ -76,10 +79,12 @@ SUNO_COOKIE=<your-cookie>
"monthly_usage": 0
}
```
则已经正常运行。
### 5. 使用Suno API
你可以在 `<域名>/docs`查看详细的API文档。
### 5. 使用 Suno API
你可以在 `<域名>/docs`查看详细的 API 文档。
## API 说明
@ -90,7 +95,7 @@ Suno API 目前主要实现了以下 API:
- `/api/custom_generate`: 创建音乐(自定义模式,支持设置歌词、音乐风格、设置标题等)
- `/api/get`: 获取音乐
- `/api/get_limit`: 获取配额信息
````
```
详细文档请查看演示站点: [https://.../docs](https://.../docs)