POST/v1/chat/completions

Responses 格式概览

使用 /v1/responses 统一提交音乐或歌词任务，支持后台返回、同步等待和 SSE 流式观察。此处说明 SunoAPI 插件实际实现的兼容范围。

API Key application/json

接口与鉴权

基础地址为 https://top.qingyuntop.ai。POST 使用 Authorization: Bearer YOUR_API_KEY 与 Content-Type: application/json；GET 只需鉴权头。

操作	入口
创建	POST `/v1/responses`
查询	GET `/v1/responses/{response_id}`

Responses 是 New API 将任务包装成 Responses 对象的协议适配，不是 Suno 官方接口，也不表示支持所有通用 Responses 参数。

模型与参数位置

字段	用法
model	suno_music 生成音乐，suno_lyrics 生成歌词
input	字符串，或包含 input_text/text 的内容数组；多个文本片段用换行拼接
metadata	JSON 对象，放置上游音乐字段，如 mv、prompt、title、tags、make_instrumental
background	true：提交后返回可查询的 Response；默认 false
stream	true：返回 SSE；默认 false

metadata 在此插件中是上游业务参数容器，可以包含布尔值，不是通用 SDK 里仅用于字符串标签的语义。建议按本目录 HTTP 示例调用；某些 SDK 对 metadata 类型的限制可能不适用。

只提取文本输入。图片、音频、文件、tools、temperature、instructions 和聊天上下文续接没有在此插件中实现对应音乐能力，不要把 messages 或音频上传格式套到本入口。

选择返回方式

设置	行为
background=true，stream=false	推荐用于音乐：提交后返回 ID，随后 GET 查询
background=false，stream=false	保持请求等待完成；达到服务器观察时限仍可能返回待查询状态
background=false，stream=true	在 SSE 中观察进度和最终文本；不是实时音频流
background=true，stream=true	后台任务同时通过 SSE 观察；仍应保存 ID 以便断线后查询

无论哪种方式，都要保存返回的 id 和 metadata.task_id。前者查询 Responses，后者用于下载音乐，不要通过改前缀自行转换 ID。

开始使用

Responses 生成音乐：用歌曲描述创建后台任务。
自定义歌词与纯音乐：说明 metadata 与 input 的优先级。
Responses 生成歌词：只返回歌词文本。
流式观察：读取 SSE。
查询与结果解析：识别状态、提取文本与获取下载 ID。

本页替代旧的 Chat Completions 说明。上游 SunoAPI 项目有自己的 Chat 路由，但当前 New API SunoAPI 插件没有声明该协议；不能据此保证本站 Suno 模型能经由 Chat Completions 调用。

Request

请求

/v1/chat/completions

Body

必填

Bodyobject

modelstring必填

要使用的模型的 ID。有关哪些模型可与聊天 API 一起使用的详细信息,请参阅模型端点兼容性表。

messagesarray<object>必填

至今为止对话所包含的消息列表。Python 代码示例。

元素object

rolestring

contentstring

temperatureinteger

使用什么采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更加随机，而较低的值（如 0.2）将使输出更加集中和确定。我们通常建议改变这个或`top_p`但不是两者。

top_pinteger

一种替代温度采样的方法，称为核采样，其中模型考虑具有 top_p 概率质量的标记的结果。所以 0.1 意味着只考虑构成前 10% 概率质量的标记。我们通常建议改变这个或`temperature`但不是两者。

ninteger

默认为 1 为每个输入消息生成多少个聊天补全选择。

streamboolean

默认为 false 如果设置,则像在 ChatGPT 中一样会发送部分消息增量。标记将以仅数据的服务器发送事件的形式发送,这些事件在可用时,并在 data: [DONE] 消息终止流。Python 代码示例。

stopstring

默认为 null 最多 4 个序列,API 将停止进一步生成标记。

max_tokensinteger

默认为 inf 在聊天补全中生成的最大标记数。输入标记和生成标记的总长度受模型的上下文长度限制。计算标记的 Python 代码示例。

presence_penaltynumber

-2.0 和 2.0 之间的数字。正值会根据到目前为止是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。 [查看有关频率和存在惩罚的更多信息。](https://platform.openai.com/docs/api-reference/parameter-details)

frequency_penaltynumber

默认为 0 -2.0 到 2.0 之间的数字。正值根据文本目前的存在频率惩罚新标记,降低模型重复相同行的可能性。有关频率和存在惩罚的更多信息。

logit_biasnull

修改指定标记出现在补全中的可能性。接受一个 JSON 对象,该对象将标记(由标记器指定的标记 ID)映射到相关的偏差值(-100 到 100)。从数学上讲,偏差在对模型进行采样之前添加到模型生成的 logit 中。确切效果因模型而异,但-1 和 1 之间的值应减少或增加相关标记的选择可能性;如-100 或 100 这样的值应导致相关标记的禁用或独占选择。

userstring

代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。[了解更多](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids)。

response_formatobject

指定模型必须输出的格式的对象。将 { "type": "json_object" } 启用 JSON 模式,这可以确保模型生成的消息是有效的 JSON。重要提示:使用 JSON 模式时,还必须通过系统或用户消息指示模型生成 JSON。如果不这样做,模型可能会生成无休止的空白流,直到生成达到令牌限制,从而导致延迟增加和请求“卡住”的外观。另请注意,如果 finish_reason="length",则消息内容可能会被部分切断,这表示生成超过了 max_tokens 或对话超过了最大上下文长度。显示属性

seeninteger

此功能处于测试阶段。如果指定,我们的系统将尽最大努力确定性地进行采样,以便使用相同的种子和参数进行重复请求应返回相同的结果。不能保证确定性,您应该参考 system_fingerprint 响应参数来监控后端的更改。

toolsarray<string>必填

模型可以调用的一组工具列表。目前,只支持作为工具的函数。使用此功能来提供模型可以为之生成 JSON 输入的函数列表。

元素string

tool_choiceobject必填

控制模型调用哪个函数(如果有的话)。none 表示模型不会调用函数,而是生成消息。auto 表示模型可以在生成消息和调用函数之间进行选择。通过 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该函数。如果没有函数存在,默认为 none。如果有函数存在,默认为 auto。显示可能的类型

路径、查询与 Header 参数

参数	位置	类型	必填	说明	示例
`Content-Type`	Header	string	是	-	application/json
`Accept`	Header	string	是	-	application/json
`Authorization`	Header	string	是	必填。使用青云TOP API 的 API Key，保留 Bearer 后的空格。	Bearer YOUR_API_KEY

请求示例application/json

curl -X POST https://top.qingyuntop.ai/v1/chat/completions \
  -H "Authorization: Bearer ${QINGYUN_TOP_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "gpt-4o",
  "messages": [
    {
      "role": "user",
      "content": "nihao。"
    }
  ],
  "max_tokens": 1000
}'

Response

返回响应 `200`

HTTP 响应

响应 200object

idstring必填

objectstring必填

createdinteger必填

choicesarray<object>必填

元素object

indexinteger

messageobject

rolestring必填

contentstring必填

finish_reasonstring

usageobject必填

prompt_tokensinteger必填

completion_tokensinteger必填

total_tokensinteger必填

响应示例json

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "\n\nHello there, how may I assist you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}