docs: Add documentation for the new API
Add documentation for the new API, change the API response to English.
This commit is contained in:
blueeon
parent
7ca5d13c5d
commit
7e34a3f5d9
@ -33,6 +33,7 @@ We have deployed an example bound to a free Suno account, so it has daily usage
|
||||
|
||||
- Perfectly implements the creation API from app.suno.ai
|
||||
- Automatically keep the account active.
|
||||
- Compatible with the format of OpenAI’s `/v1/chat/completions` API.
|
||||
- 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.
|
||||
@ -116,6 +117,7 @@ Suno API currently mainly implements the following APIs:
|
||||
|
||||
```bash
|
||||
- `/api/generate`: Generate music
|
||||
- `/v1/chat/completions`: Generate music - Call the generate API in a format that works with OpenAI’s API.
|
||||
- `/api/custom_generate`: Generate music (Custom Mode, support setting lyrics, music style, title, etc.)
|
||||
- `/api/generate_lyrics`: Generate lyrics based on prompt
|
||||
- `/api/get`: Get music information based on the id. Use “,” to separate multiple ids.
|
||||
|
||||
@ -33,6 +33,7 @@ Suno.ai v3 是一个令人惊叹的 AI 音乐服务，虽然官方还没有开
|
||||
|
||||
- 完美的实现了 app.suno.ai 中的大部分 API
|
||||
- 自动保持账号活跃
|
||||
- 兼容OpenAI的 `/v1/chat/completions` API 格式
|
||||
- 支持 Custom Mode
|
||||
- 一键部署到 vercel
|
||||
- 除了标准 API，还适配了 GPTs、coze 等 Agent 平台的 API Schema，所以你可以把它当做一个 LLM 的工具/插件/Action，集成到任意 AI Agent 中。
|
||||
@ -114,6 +115,7 @@ Suno API 目前主要实现了以下 API:
|
||||
|
||||
```bash
|
||||
- `/api/generate`: 创建音乐
|
||||
- `/v1/chat/completions`: 创建音乐 - 用OpenAI API 兼容的格式调用 generate API
|
||||
- `/api/custom_generate`: 创建音乐（自定义模式，支持设置歌词、音乐风格、设置标题等）
|
||||
- `/api/generate_lyrics`: 根据Prompt创建歌词
|
||||
- `/api/get`: 根据id获取音乐信息。获取多个请用","分隔，不传ids则返回所有音乐
|
||||
|
||||
@ -20,6 +20,8 @@ export default function Docs() {
|
||||
|
||||
\`\`\`bash
|
||||
- \`/api/generate\`: Generate music
|
||||
- \`/v1/chat/completions\`: Generate music - Call the generate API in a format
|
||||
that works with OpenAI’s API.
|
||||
- \`/api/custom_generate\`: Generate music (Custom Mode, support setting lyrics,
|
||||
music style, title, etc.)
|
||||
- \`/api/generate_lyrics\`: Generate lyrics based on prompt
|
||||
|
||||
@ -11,32 +11,22 @@
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"/api/custom_generate": {
|
||||
"/api/generate": {
|
||||
"post": {
|
||||
"summary": "Generate Audio - Custom Mode",
|
||||
"description": "The custom mode enables users to provide additional details about the music, such as music genre, lyrics, and more.\n\n 2 audio files will be generated for each request, consuming a total of 10 credits. \n\n `wait_audio` can be set to API mode:\n\n\u2022 By default, it is set to false, which indicates the background mode. It will only return audio task information, and you will need to call the get API to retrieve detailed audio information.\n\n\u2022 If set to true, it simulates synchronous mode. The API will wait for a maximum of 100s until the audio is generated, and will directly return the audio link and other information. Recommend using in GPTs and other agents.",
|
||||
"summary": "Generate audio based on Prompt.",
|
||||
"description": "It will automatically fill in the lyrics.\n\n2 audio files will be generated for each request, consuming a total of 10 credits.\n\n`wait_audio` can be set to API mode:\n\n\u2022 By default, it is set to `false`, which indicates the background mode. It will only return audio task information, and you will need to call the get API to retrieve detailed audio information.\n\n\u2022 If set to `true`, it simulates synchronous mode. The API will wait for a maximum of 100s until the audio is generated, and will directly return the audio link and other information. Recommend using in GPTs and other agents.",
|
||||
"tags": ["default"],
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": ["prompt", "tags", "title"],
|
||||
"required": ["prompt", "make_instrumental", "wait_audio"],
|
||||
"properties": {
|
||||
"prompt": {
|
||||
"type": "string",
|
||||
"description": "Detailed prompt, including information such as music lyrics.",
|
||||
"example": "[Verse 1]\nCruel flames of war engulf this land\nBattlefields filled with death and dread\nInnocent souls in darkness, they rest\nMy heart trembles in this silent test\n\n[Verse 2]\nPeople weep for loved ones lost\nBattered bodies bear the cost\nSeeking peace and hope once known\nOur grief transforms to hearts of stone\n\n[Chorus]\nSilent battlegrounds, no birds' song\nShadows of war, where we don't belong\nMay flowers of peace bloom in this place\nLet's guard this precious dream with grace\n\n[Bridge]\nThrough the ashes, we will rise\nHand in hand, towards peaceful skies\nNo more sorrow, no more pain\nTogether, we'll break these chains\n\n[Chorus]\nSilent battlegrounds, no birds' song\nShadows of war, where we don't belong\nMay flowers of peace bloom in this place\nLet's guard this precious dream with grace\n\n[Outro]\nIn unity, our strength will grow\nA brighter future, we'll soon know\nFrom the ruins, hope will spring\nA new dawn, we'll together bring"
|
||||
},
|
||||
"tags": {
|
||||
"type": "string",
|
||||
"description": "Music genre",
|
||||
"example": "pop metal male melancholic"
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "Music title",
|
||||
"example": "Silent Battlefield"
|
||||
"description": "Prompt",
|
||||
"example": "A popular heavy metal song about war, sung by a deep-voiced male singer, slowly and melodiously. The lyrics depict the sorrow of people after the war."
|
||||
},
|
||||
"make_instrumental": {
|
||||
"type": "boolean",
|
||||
@ -79,10 +69,10 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/generate": {
|
||||
"/v1/chat/completions": {
|
||||
"post": {
|
||||
"summary": "Generate audio based on Prompt.",
|
||||
"description": "It will automatically fill in the lyrics.\n\n2 audio files will be generated for each request, consuming a total of 10 credits.\n\n`wait_audio` can be set to API mode:\n\n\u2022 By default, it is set to `false`, which indicates the background mode. It will only return audio task information, and you will need to call the get API to retrieve detailed audio information.\n\n\u2022 If set to `true`, it simulates synchronous mode. The API will wait for a maximum of 100s until the audio is generated, and will directly return the audio link and other information. Recommend using in GPTs and other agents.",
|
||||
"summary": "Generate audio based on Prompt - OpenAI API format compatibility.",
|
||||
"description": "Convert the `/api/generate` API to be compatible with the OpenAI `/v1/chat/completions` API format. \n\nGenerally used in OpenAI compatible clients.",
|
||||
"tags": ["default"],
|
||||
"requestBody": {
|
||||
"content": {
|
||||
@ -95,6 +85,58 @@
|
||||
"type": "string",
|
||||
"description": "Prompt",
|
||||
"example": "A popular heavy metal song about war, sung by a deep-voiced male singer, slowly and melodiously. The lyrics depict the sorrow of people after the war."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "success",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "string",
|
||||
"description": "Text description for music, with details like title, album cover, lyrics, and more."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/custom_generate": {
|
||||
"post": {
|
||||
"summary": "Generate Audio - Custom Mode",
|
||||
"description": "The custom mode enables users to provide additional details about the music, such as music genre, lyrics, and more.\n\n 2 audio files will be generated for each request, consuming a total of 10 credits. \n\n `wait_audio` can be set to API mode:\n\n\u2022 By default, it is set to false, which indicates the background mode. It will only return audio task information, and you will need to call the get API to retrieve detailed audio information.\n\n\u2022 If set to true, it simulates synchronous mode. The API will wait for a maximum of 100s until the audio is generated, and will directly return the audio link and other information. Recommend using in GPTs and other agents.",
|
||||
"tags": ["default"],
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"required": ["prompt", "tags", "title"],
|
||||
"properties": {
|
||||
"prompt": {
|
||||
"type": "string",
|
||||
"description": "Detailed prompt, including information such as music lyrics.",
|
||||
"example": "[Verse 1]\nCruel flames of war engulf this land\nBattlefields filled with death and dread\nInnocent souls in darkness, they rest\nMy heart trembles in this silent test\n\n[Verse 2]\nPeople weep for loved ones lost\nBattered bodies bear the cost\nSeeking peace and hope once known\nOur grief transforms to hearts of stone\n\n[Chorus]\nSilent battlegrounds, no birds' song\nShadows of war, where we don't belong\nMay flowers of peace bloom in this place\nLet's guard this precious dream with grace\n\n[Bridge]\nThrough the ashes, we will rise\nHand in hand, towards peaceful skies\nNo more sorrow, no more pain\nTogether, we'll break these chains\n\n[Chorus]\nSilent battlegrounds, no birds' song\nShadows of war, where we don't belong\nMay flowers of peace bloom in this place\nLet's guard this precious dream with grace\n\n[Outro]\nIn unity, our strength will grow\nA brighter future, we'll soon know\nFrom the ruins, hope will spring\nA new dawn, we'll together bring"
|
||||
},
|
||||
"tags": {
|
||||
"type": "string",
|
||||
"description": "Music genre",
|
||||
"example": "pop metal male melancholic"
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "Music title",
|
||||
"example": "Silent Battlefield"
|
||||
},
|
||||
"make_instrumental": {
|
||||
"type": "boolean",
|
||||
|
||||
@ -18,6 +18,7 @@ We update quickly, please star us on Github: [github.com/gcui-art/suno-api](htt
|
||||
## 🌟 Features
|
||||
|
||||
- Perfectly implements the creation API from \`app.suno.ai\`
|
||||
- Compatible with the format of OpenAI’s \`/v1/chat/completions\` API.
|
||||
- Automatically keep the account active.
|
||||
- Supports \`Custom Mode\`
|
||||
- One-click deployment to Vercel
|
||||
@ -96,6 +97,8 @@ Suno API currently mainly implements the following APIs:
|
||||
|
||||
\`\`\`bash
|
||||
- \`/api/generate\`: Generate music
|
||||
- \`/v1/chat/completions\`: Generate music - Call the generate API in a format
|
||||
that works with OpenAI’s API.
|
||||
- \`/api/custom_generate\`: Generate music (Custom Mode, support setting lyrics,
|
||||
music style, title, etc.)
|
||||
- \`/api/generate_lyrics\`: Generate lyrics based on prompt
|
||||
|
||||
@ -36,7 +36,7 @@ export async function POST(req: NextRequest) {
|
||||
const audioInfo = await (await sunoApi).generate(userMessage.content, true, true);
|
||||
|
||||
const audio = audioInfo[0]
|
||||
const data = `## 歌曲名称：${audio.title}\n\n### 歌词：\n${audio.lyric}\n### 听歌链接： ${audio.audio_url}`
|
||||
const data = `## Song Title: ${audio.title}\n\n### Lyrics:\n${audio.lyric}\n### Listen to the song: ${audio.audio_url}`
|
||||
|
||||
return new NextResponse(data, {
|
||||
status: 200,
|
||||
@ -47,7 +47,7 @@ export async function POST(req: NextRequest) {
|
||||
}
|
||||
});
|
||||
} catch (error: any) {
|
||||
console.error('Error generating custom audio:', JSON.stringify(error.response.data));
|
||||
console.error('Error generating audio:', JSON.stringify(error.response.data));
|
||||
return new NextResponse(JSON.stringify({ error: 'Internal server error: ' + JSON.stringify(error.response.data.detail) }), {
|
||||
status: 500,
|
||||
headers: {
|
||||
|
||||
Loading…
Reference in New Issue
Block a user