New APINew API
使用指南部署安装API 参考AI 应用Skills插件帮助支持商务合作合规与使用政策
⚠️合规提示:本项目仅用于合法授权的 API 网关、内部管理和私有化部署场景。请遵守上游服务条款、平台规则、监管要求和内容安全要求。
用户指南

游乐场

在网页中选择分组和模型、调整参数并与模型对话,测试模型效果;并提供用 API 调用模型的地址、认证方式、SDK 示例和支持的接口端点。

  • 从侧边栏「聊天」→「游乐场」进入。
  • 在网页中与模型对话,测试模型和请求参数。
  • 调用模型会按价格扣账户里的额度(钱包余额或订阅额度)。

提示

  • 游乐场使用当前登录的账户调用模型,不使用 API 密钥:不受密钥的额度、模型限制和 IP 限制约束,也不计入任何密钥的已用额度。
  • 对话记录仅保存在当前浏览器中,按登录账户分开保存,不上传到服务器。
  • 左侧边栏无「游乐场」页时:
    到「个人资料」页的「左侧边栏个人设置」区域中,开启「聊天区域」和「游乐场」并保存。

游乐场概览

  • 游乐场-对话

游乐场-对话页面

页面上方为对话区,下方为输入框,可完成以下操作:

提示

发送后提示错误或没有回复时,查看常见问题

区域说明:

下表按页面中从上到下、从左到右的顺序排列。

区域定义显示条件备注
对话区当前对话的消息列表,包括发送的消息和模型的回复。始终显示。无消息时显示「开始一场游乐场对话」和「分析数据」「总结文本」「代码」「获取建议」四个入门提示。点击入门提示会直接发送对应的提示词。消息下方的操作见消息操作。
输入框填写发送给模型的内容,占位文字为「随便问」。始终显示,生成回复期间不可输入。按 Enter 发送,按 Shift+Enter 换行。
工具栏输入框左下方的附加、搜索、参数、清空聊天历史四个图标。始终显示,生成回复期间不可用。参数图标右上角的数字为已启用的参数个数。各图标见输入框与工具栏。
分组与模型选择器本次对话使用的分组和模型。始终显示。生成回复期间、模型列表加载中或账户无可用分组时不可用。位于输入框右下方,按钮上显示当前模型和分组,未选择时显示「模型」「分组」。窄屏(如手机)时位于工具栏上方。
发送 / 停止发送输入框中的内容,或停止正在生成的回复。生成回复期间,「发送」变为红色的「停止」。输入框为空,或所选分组下无可用模型时,「发送」不可用。窄屏时仅显示图标。

发送消息并查看回复

操作流程:

  1. 选择分组与模型:点击输入框右下方的分组与模型选择器,在左侧「模型分组」中选择分组,在右侧选择模型。
  2. 设置请求参数:按需点击输入框下方的参数图标,在「参数设置」中启用并调整参数,见调整请求参数。
  3. 填写对话内容:在输入框中输入问题、指令或提示词。
  4. 发送请求:点击「发送」,或按 Enter。
  5. 查看回复:在对话区查看模型逐步输出的回复;需要中断时,点击「停止」。

提示

  • 切换分组后,所选模型不在新分组中时,自动改为新分组中的第一个模型。
  • 推理模型的思考过程显示在回复上方,生成中显示「思考中...」,完成后显示「思考了 … 秒」,点击可展开或收起。
  • 点击「停止」后,已输出的内容保留在对话中。
  • 输入框下方的「附加」「搜索」目前未实现,点击后仅提示「功能开发中」「搜索功能开发中」,无法发送文件、图片或联网搜索。

配置项说明:

分组与模型选择器分左右两栏,下表按从左到右的顺序排列。

配置项定义填写要求和限制默认值
分组调用使用的分组,决定可用的模型和计费倍率。在左侧「模型分组」中选择,仅列出账户有权使用的分组,包括账户所在的分组;站点允许时包括 auto(由系统自动选择可用分组)。列表仅显示分组名称。default,无此分组时为列表中的第一个分组;之后沿用上次的选择。
模型本次对话调用的模型。在右侧列表中选择,可在「搜索模型...」中按名称搜索,无匹配时显示「未找到模型。」。列表为所选分组下可用的模型,不受 API 密钥「模型限制」的影响。gpt-4o,不在列表中时为列表中的第一个模型;之后沿用上次的选择。

调整请求参数

操作流程:

  1. 点击输入框下方的参数图标(鼠标悬停显示「参数」),打开「参数设置」。
  2. 打开需要发送的参数右侧的开关。
  3. 拖动滑块或填写数值。

提示

  • 仅启用的参数随请求发送。参数的数值和开关保存在当前浏览器中,下次打开时沿用。
  • 部分模型不支持某些参数,发送后报错时,请关闭相应的参数后重试。
  • 游乐场不提供系统提示词和关闭流式输出的设置,回复始终逐步输出。

配置项说明:

「参数设置」窗口不分区,每个参数右侧有一个开关,下表按窗口中的顺序排列。

配置项定义填写要求和限制默认值
温度控制输出的随机性和创造性。拖动滑块调整,范围 0.1~1,步长 0.1。0.7,已启用
Top P按概率质量限制词元选择范围。拖动滑块调整,范围 0.1~1,步长 0.1。1,已启用
频率惩罚减少重复措辞。拖动滑块调整,范围 -2~2,步长 0.1。0,已启用
存在惩罚鼓励讨论新话题。拖动滑块调整,范围 -2~2,步长 0.1。0,已启用
最大 Tokens限制回复长度。填写 0~200000 的整数,超出范围时自动改为最接近的有效值。4096,未启用
随机种子让兼容模型的回复更可复现。填写 0~2147483647 的整数。未填写时显示「未设置」,即使启用也不发送。未设置,未启用

管理对话

重新生成操作流程:

  1. 将鼠标移到需要重新生成的消息上。
  2. 点击消息下方的重新生成图标(鼠标悬停显示「重新生成」)。

编辑操作流程:

  1. 点击消息下方的编辑图标。
  2. 在文本框中修改内容。
  3. 编辑用户消息时,点击「保存并提交」按修改后的内容重新生成回复;仅保存修改时,点击「保存」。

删除操作流程:

  1. 点击消息下方的删除图标。

清空聊天历史操作流程:

  1. 点击输入框下方的垃圾桶图标(鼠标悬停显示「清空聊天历史」)。
  2. 在「清空聊天历史?」窗口中点击「清空」。

注意

清空后对话记录无法恢复。清空仅删除消息,分组、模型和参数保持不变。

提示

  • 每次发送时,对话中已有的消息会一并作为上下文发送给模型,思考过程不发送。开始新话题前,请先清空聊天历史。
  • 生成回复期间,重新生成、编辑、删除和清空聊天历史不可用。
  • 窄屏时,消息的操作收在消息下方的 ⋯ 菜单中。

操作项说明

输入框与工具栏

操作位置说明
入门提示对话区中部,无消息时显示「分析数据」「总结文本」「代码」「获取建议」,点击后直接发送对应的提示词。
附加输入框左下方的回形针图标菜单中有「上传文件」「上传照片」「截图」「拍照」,目前均未实现,点击后提示「功能开发中」。
搜索输入框左下方的地球图标目前未实现,点击后提示「搜索功能开发中」。
参数输入框左下方的滑块图标打开「参数设置」,见调整请求参数。右上角的数字为已启用的参数个数。
清空聊天历史输入框左下方的垃圾桶图标无消息时不可用,见管理对话。
分组与模型选择器输入框右下方见发送消息并查看回复。
发送输入框右下角发送输入框中的内容,也可按 Enter;按 Shift+Enter 换行。
停止输入框右下角,生成回复期间替代「发送」立即中断生成,已输出的内容保留。

消息操作

操作位置说明
复制消息下方的复制图标复制消息内容,复制后短暂显示「已复制!」。
显示源码、显示预览回复下方的代码图标在「原始回复」原文和排版后的内容之间切换。
重新生成消息下方的刷新图标删除该消息之后的所有消息并重新发送;在回复上操作时,该回复本身也会删除。
编辑消息下方的编辑图标消息变为文本框,可「保存」「取消」,有修改时可「重置」;用户消息另有「保存并提交」。
删除消息下方的删除图标仅删除该条消息,无确认窗口。
重试、编辑、删除出错回复下方「重试」删除该回复后重新发送;「编辑」编辑上一条用户消息;「删除」删除该出错回复。
打开菜单窄屏时消息下方的 ⋯展开上述操作。

提示

编辑时按 Ctrl+Enter(macOS 为 Cmd+Enter)保存,用户消息为保存并提交;按 Esc 取消。有未保存的修改时取消,会弹出「未保存的更改」确认窗口。

API 地址与认证

网关的 OpenAI 兼容地址通常为:

https://your-host/v1

使用 API 密钥作为 Bearer Token:

Authorization: Bearer sk-your-api-key

以聊天补全为例:

curl https://your-host/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-api-key" \
  -d '{"model":"gpt-4o-mini","messages":[{"role":"user","content":"你好"}]}'

SDK 示例

Python(OpenAI SDK)

from openai import OpenAI

client = OpenAI(
    api_key="sk-xxxxxxxx",
    base_url="https://your-host/v1",
)

response = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "你好"}],
)
print(response.choices[0].message.content)

Claude 原生格式

curl https://your-platform.com/v1/messages \
  -H "x-api-key: sk-xxxxxxxx" \
  -H "anthropic-version: 2023-06-01" \
  -H "content-type: application/json" \
  -d '{"model": "claude-3-5-sonnet-20241022", "max_tokens": 1024, "messages": [{"role": "user", "content": "Hello"}]}'

Gemini 原生格式

curl "https://your-platform.com/v1beta/models/gemini-1.5-pro:generateContent?key=sk-xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"contents": [{"parts": [{"text": "Hello"}]}]}'

支持的接口端点

接口路径说明
聊天补全POST /v1/chat/completionsOpenAI Chat Completions 兼容接口,要求提供 model 和 messages,支持流式或普通响应。
文本补全POST /v1/completions传统文本补全接口,要求提供 prompt 和 model。
向量嵌入POST /v1/embeddings将文本或文本数组转换为向量,要求提供 input,由渠道适配器转换为上游格式。
图像生成POST /v1/images/generations根据提示词生成图像,具体模型、尺寸、质量和数量取决于请求参数及已配置渠道。
图像编辑POST /v1/images/edits根据输入图像和提示词进行图像编辑,支持 JSON 和 multipart/form-data 请求。
旧版编辑接口POST /v1/edits保留的旧版路径,当前不可用;图像编辑请使用 /v1/images/edits。
语音转文字POST /v1/audio/transcriptions将音频转换为文字,按照 OpenAI 音频接口格式转发到对应语音识别渠道。
音频翻译POST /v1/audio/translations识别音频内容并输出翻译后的文字。
文字转语音POST /v1/audio/speech将输入文本转换为音频。
重排序POST /v1/rerank根据 query 对候选 documents 进行相关性排序,要求查询内容和文档列表不为空。
内容审核POST /v1/moderations对文本或其他输入执行内容审核;未提供模型时会使用默认审核模型候选。
Responses APIPOST /v1/responsesOpenAI Responses 格式接口,支持输入、工具和响应事件等能力。
Responses WebSocketGET /v1/responses(WebSocket)以 WebSocket 连接 Responses 接口,连接后发送 response.create 事件创建响应;收到第一个 response.create 事件后选择渠道,API 密钥的传递方式与实时对话相同。
Responses 压缩POST /v1/responses/compact对 Responses 请求上下文执行压缩处理。
Codex 网页搜索POST /v1/alpha/searchCodex 独立网页搜索格式接口,目前仅允许支持该能力的 Sub2API、New API、Codex 和高级自定义渠道处理。
DeepSeek 搜索POST /v1/tools/searchDeepSeek 搜索接口,请求体原样转发、响应原样返回;固定按模型 deepseek-search 选择渠道并按次计费,不计 Token;目前仅允许 DeepSeek、New API、Sub2API 和高级自定义渠道处理。
DeepSeek 网页抓取POST /v1/tools/fetchDeepSeek 网页抓取接口,固定按模型 deepseek-fetch 选择渠道并按次计费;转发方式和可用渠道同 DeepSeek 搜索。
Claude MessagesPOST /v1/messagesAnthropic Claude Messages 兼容接口,要求提供 model 和消息内容,必要时由 New API 转换为上游协议;/v1/messages/count_tokens 当前未启用。
实时对话GET /v1/realtime(WebSocket)OpenAI Realtime 风格的双向实时通信接口,模型通常通过查询参数传入,API 密钥可通过 Bearer Token 或 WebSocket 子协议传递。
Gemini 原生模型调用POST /v1beta/models/{model}:{action}Gemini 原生格式接口,支持模型操作路径,例如 generateContent、streamGenerateContent 和嵌入相关操作;:countTokens 当前不支持,返回 404。
Gemini 兼容模型调用POST /v1/models/{model}:{action}以 /v1 前缀承接 Gemini 风格的模型操作请求,由 Gemini Relay 负责解析和转换。
模型列表GET /v1/models默认返回 OpenAI 格式模型列表;同时带 x-api-key 和 anthropic-version 请求头时返回 Claude 格式,带 x-goog-api-key 请求头或 key 查询参数时返回 Gemini 格式。
模型详情GET /v1/models/{model}查询单个模型信息;模型不存在时返回 model_not_found 错误对象(HTTP 状态码仍为 200)。
Gemini 模型列表GET /v1beta/models以 Gemini 格式返回可用模型列表,响应字段包括 models 和 nextPageToken。
OpenAI 格式模型列表GET /v1beta/openai/models在 Gemini 兼容命名空间下,以 OpenAI 格式返回模型列表。

常见问题

相关文档

  • API 密钥:创建 API 密钥,复制 API 地址和密钥,在客户端中调用模型。
  • 使用日志:查看游乐场和 API 调用的扣费明细。
  • 钱包:充值、兑换额度,查看订阅。
  • 模型广场与排行榜:查看可用的模型和价格。
  • 个人资料:设置左侧边栏显示的页面。
  • 聊天:在 Cherry Studio 等聊天应用中使用模型。
  • API 参考:各接口的请求参数和返回格式。

这篇文档对您有帮助吗?

最后更新于