跳到正文
API 演练场

API 演练场

交互式

用你自己的密钥在浏览器中试用所有模型和端点——流式输出、请求检查器，以及可直接粘贴到应用中的生成代码。

启动 Playground

Playground 是位于 /docs/playground 的 API 聊天控制台。你与模型对话，Playground 会发送与你的代码相同的请求：发往三个端点之一，并带上你设置的模型、系统提示词、参数和工具。每个请求都可以回看为代码和原始流事件。

开始

  • 提供密钥 — 登录后，Playground 使用你账户的 API 密钥并显示你的余额。未登录时，选择添加密钥并粘贴密钥：它仅保留在此标签页中，不会被保存。
  • 选择端点和模型 — 顶栏包含端点开关和模型选择器。新对话默认使用 Chat Completions 和 shannon-3。
  • 发送消息 — 在下方输入并按回车。每次回复都会加入对话，因此下一条消息会接着继续。空白界面提供三个起始提示和一个现成的工具调用示例。

你可以在密钥与用量页面找到并轮换你的密钥。 密钥与用量

端点与模型

端点开关决定 Playground 构建哪种请求格式。你可以在对话进行中切换，消息会保留。

端点 发送的请求 参考
Chat Completions POST /v1/chat/completions Chat Completions
Responses POST /v1/responses Responses API
Messages POST /v1/messages Anthropic 格式

模型选择器列出 GET /v1/models 返回的内容。它可以搜索，会把你最近使用的模型置顶，并为每个模型显示每 1M tokens 的价格、上下文窗口，以及工具、图片输入、推理和结构化输出的标记。

对话

  • 回复在生成时以流的形式进入对话。模型的推理显示在单独的块中，你可以将其折叠。
  • 每条回复下方显示：首个 token 的耗时、每秒 tokens 数、总耗时、输入和输出 tokens（含缓存部分和推理部分）、该轮费用的估算、结束原因和响应 id。
  • 你的消息可以编辑并从该处重新发送。回复可以重新生成。消息可以删除，删除后的几秒内可以撤销。
  • 停止或 Esc 键会结束正在生成的回复。
  • 对于支持图片的模型，可以通过图片按钮、粘贴或拖入文件来附加图片。图片在发送前会被缩放到长边 1,568 像素。超过 30 MB 的文件会被跳过。
  • 输入框和系统提示词会显示 token 数。对于托管开源权重模型，这是来自 POST /v1/tokenize 的精确计数。对于其他模型，这是估算值，以 ≈ 标记。
  • 请求失败时会提示下一步该做什么：密钥被拒绝时设置密钥，余额用完时充值，请求过多时等待相应秒数，或在服务器错误后重试。

请求设置

设置按钮会打开一个包含六个标签页的面板。设置属于对话：每个对话保留各自的设置。

标签页 包含内容
系统 对话的系统提示词，随每个请求发送。五个模板可以填入它，并显示其 token 数。
参数 最大输出 tokens、温度、top_p、推理强度、停止序列、seed，以及流式传输和联网搜索的开关。所选端点没有对应字段的控件会被关闭并加以标记。
工具 随请求发送的工具定义：四个预设（get_weather、read_file、run_shell、web_search），或你自己以 JSON 写的定义，以及 tool_choice（auto、none、required，或按名称指定某个工具）。当模型调用工具时，对话会显示该调用，并带有一个填写结果的框。开启提供示例结果后，点击一下即可填入示例结果。你也可以输入自己的结果，然后发送以继续该轮。
结构化 response_format：text、json_object，或带有 schema 名称和 JSON schema 的 json_schema。设置了 schema 后，最后一个回答会据此校验，并在对话中标记为符合或不符合。Messages 端点上该标签页被关闭，所选模型不支持的选项不会提供。
代码 当前对话的请求，以 cURL、Python、Node 或 Go 代码呈现，由对话及其设置生成。密钥显示为 YOUR_API_KEY。代码可以复制，也可以在大视图中打开。
事件 最近一轮在网络上传输的实际内容：每个流事件及其时间偏移和过滤器、组装后的回复、回复标头（x-request-id、content-type、retry-after、date）以及请求体。这些内容会保留到页面重新加载。

输入检查

你输入的值在请求发送前会被检查。超出范围的值会在其字段处标出，在修正之前无法发送。

设置 检查
最大输出 tokens 从 1 到该模型 max_output_tokens 的整数。
温度 0 到 2 之间的数字。留空则请求中不包含该字段。
top_p 0 到 1 之间的数字。留空则请求中不包含该字段。
seed 整数。
停止序列 最多 4 个，用逗号分隔。
response_format 必须是所选模型接受的取值。若对话被切换到不支持 json_schema 或不支持 response_format 的模型，发送会被拦下并说明原因。
图片 切换到仅支持文本的模型时，图片会从消息中移除，并附带提示。

比较两个模型

更多菜单中的比较两个模型会增加第二个模型选择器。此后每条消息会以相同设置同时发给两个模型，两份回答并排显示，分别标记为 A 和 B。你可以单独重新生成其中一侧。当某一侧调用工具时，你发送的结果只会继续该侧。

分享、导出与导入

  • 复制分享链接 会把对话打包进链接本身，位于 # 之后的部分。不会上传任何内容。图片、你的密钥以及最近一次运行的详情不包含在内。打开链接的人会在自己的 Playground 中得到一个新对话。
  • 对话过长而无法放进链接时，会被拒绝并给出提示。请改为下载为 JSON。
  • 下载对话 JSON 会把对话及其设置保存为文件。对话面板中的导入 JSON 可以打开这样的文件。
  • 复制为 cURL 会把当前请求复制为一条 cURL 命令。

什么保存在哪里

内容 保存位置
对话、已保存的工具、最近使用的模型、面板布局 保存在此浏览器中。它们不会发送给 Shannon，也不会跟随你到其他设备。
API 密钥 保存在当前标签页的内存中。粘贴的密钥会在页面重新加载或标签页关闭时消失。登录后，每次都从你的账户读取密钥。
最近一轮的流事件、标头和请求 保存在当前打开的页面中，直到页面重新加载。
请求 由你的浏览器携带你的密钥发送到 API。它们与其他 API 请求一样计入你的余额。

键盘

按键 作用
Enter 发送消息。
Shift + Enter 换行。
Ctrl + K 打开命令面板：切换端点或模型、设置系统模板、开始新对话、切换流式传输、工具或比较。在 Mac 上：⌘ K。
Esc 停止正在生成的回复，或在窄屏幕上关闭已打开的面板。

启动 Playground