胜算云Router文档
胜算云Router
胜算云Router
  1. API文档
  • 快速入门
  • Quick start
  • 模型路由
  • model routing
  • 联网搜索
  • Online search
  • 工具和函数调用
  • Tool and function calling
  • 常见问题
  • 错误处理
  • 使用条款
  • 隐私政策
  • 付费充值协议
  • cherry studio和chat box配置指南
  • 数据安全协议和分析
  • MCP安装
  • Roo code配置
  • 胜算云Router开放平台服务协议
  • MCP installing
  • 如何在KiloSSY中使用胜算云Router
  • API文档
    • API 错误代码说明
    • 聊天补全
      POST
    • 文本向量化
      POST
    • 多模态向量化
      POST
    • 图像生成
      POST
    • 文本分词
      POST
    • 文本重排序
      POST
  1. API文档

聊天补全

POST
/v1/chat/completions
Chat
与AI模型进行多轮对话
请求示例请求示例
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://router.shengsuanyun.com/api/v1/chat/completions' \
--header 'HTTP-Referer: https://www.postman.com' \
--header 'X-Title: Postman' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "deepseek/deepseek-v3",
    "stream": true,
    "messages": [
        {
            "role": "user",
            "content": "你好"
        }
    ],
    "stream_options": {
        "include_usage": true
    }
}'
响应示例响应示例
200 - 非流式响应
{
    "id": "20250410143202432620157mDT6DvdC",
    "provider": "OpenRouter",
    "model": "anthropic/claude-3.7-sonnet",
    "object": "chat.completion",
    "created": 1744266722,
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "I don't have the ability to check real-time weather information for Shanghai or any other location. To get accurate and current weather information for Shanghai, you could:\n\n1. Check a weather website or app such as Weather.com, AccuWeather, or a local Chinese weather service\n2. Search for \"上海天气\" (Shanghai weather) on a search engine\n3. Look at the weather function on your smartphone\n4. Check local Shanghai news websites\n\nIf you need current weather information, these sources will provide you with accurate forecasts, temperature, precipitation chances, and other relevant weather data for Shanghai today."
            },
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 16,
        "completion_tokens": 133,
        "total_tokens": 149
    }
}

请求参数

Authorization
Bearer Token
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
or
Header 参数
HTTP-Referer
string 
可选
用于在胜算云Router中排名的应用网站URL
示例值:
https://www.postman.com
X-Title
string 
可选
用于在胜算云Router中排名的应用名称
示例值:
Postman
Body 参数application/json
model
string 
必需
请求使用的模型 ID。
messages
array[object (Message) {5}] 
对话的消息列表。
可选
role
enum<string> 
该消息的角色。
必需
枚举值:
systemuserassistanttool
content
该消息的内容。
必需
name
string 
可选
为模型提供信息以区分相同角色。
tool_calls
array[object (ToolCall) {3}] 
可选
模型生成的工具调用。
tool_call_id
string 
可选
此消息所回应的工具调用 ID,当 role 为 tool 时必填。
stream
boolean 
是否使用流式响应。
可选
默认值:
false
online_search
boolean 
可选
是否启用联网搜索功能。
默认值:
false
stream_options
object (StreamOptions) 
可选
流式输出相关选项,只有在 stream 参数为 true 时,此参数才有效。
include_usage
boolean 
可选
是否在响应中包括 token 的使用信息
max_tokens
integer 
可选
限制一次请求中模型生成 completion 的最大 token 数。
temperature
number 
可选
采样温度,用于控制模型生成文本的多样性。
更高的值,如 0.8,会使输出更随机,而更低的值,如 0.2,会使其更加集中和确定。
>= 0< 2
top_p
number 
可选
核采样概率阈值,用于控制模型生成文本的多样性。
top_p 越高,生成的文本更多样。反之,生成的文本更确定。
由于 temperature 与 top_p 均可以控制生成文本的多样性,因此建议您只设置其中一个值。
>= 0< 1
stop
可选
模型遇到 stop 字段所指定的字符串时将停止继续生成,这个词语本身不会输出。
One of
n
integer 
可选
生成响应的个数。对于需要生成多个响应的场景(如创意写作、广告文案等),可以设置较大的 n 值。
当前仅支持 qwen-plus 、doubao-pro 模型,且在传入 tools 参数时固定为1。
设置较大的 n 值不会增加输入 Token 消耗,会增加输出 Token 的消耗。
>= 1<= 4
frequency_penalty
number 
可选
频率惩罚系数。如果值为正,会根据新 token 在文本中的出现频率对其进行惩罚,从而降低模型逐字重复的可能性。
>= -2<= 2
presence_penalty
number 
可选
存在惩罚系数。如果值为正,会根据新 token 到目前为止是否出现在文本中对其进行惩罚,从而增加模型谈论新主题的可能性。
>= -2<= 2
logprobs
boolean 
可选
是否返回所输出 token 的对数概率。如果为 true,则在 message 的 content 中返回每个输出 token 的对数概率。仅部分模型支持。
top_logprobs
integer 
可选
一个介于 0 到 20 之间的整数 N,指定每个输出位置返回输出概率 top N 的 token,且返回这些 token 的对数概率。指定此参数时,logprobs 必须为 true。
auto_route
boolean 
可选
是否自动路由模型供应商。
默认值:
true
supplier
enum<string> 
可选
指定模型供应商。只有在 auto_route=false 时该参数才会生效。
枚举值:
DeepSeekBytedanceOpenRouterAli
reasoning
object 
设置思维链模式
可选
effort
enum<string> 
可选
OpenAI和Claude模型支持
枚举值:
lowmediumhigh
max_tokens
integer 
可选
最大推理Token数,控制非OpenAI思考模型思维链长度,支持Claude,不可与effort共用
示例

返回响应

🟢200成功
application/json
请求成功
Body
id
string 
响应ID
必需
provider
string 
必需
Provider名称
model
string 
用户调用模型名称
必需
object
string 
对象类型
必需
created
integer 
创建时间戳
必需
choices
array[object (OpenAITextResponseChoice) {3}] 
返回消息
必需
text
string 
生成的文本
可选
index
integer 
选择索引
可选
finish_reason
string 
完成原因
可选
usage
object (UserUsage) 
用量
可选
prompt_tokens
integer 
提示词token数
可选
completion_tokens
integer 
完成token数
可选
total_tokens
integer 
总token数
可选
🟠400请求有误
修改于 2025-05-29 08:52:02
上一页
API 错误代码说明
下一页
文本向量化
Built with