AI 助手
扣子 AI 帮助与支持
你好，我是 扣子 文档问答助手 🎉
你在阅读当前文档的过程中，无论对文档概念的解释，还是文档内容方面的疑问，都可以随时向我提问，我会全力为你解答
推荐问题
如何快速了解这个空间的核心内容？
有哪些近期更新的重点文档？
我应该从哪些文档开始阅读？
文档反馈
API Playground 是扣子编程提供的在线 API 调试工具，集成了扣子编程所有 OpenAPI，支持可视化调试 API、查看帮助文档、示例代码，帮助开发者快速体验扣子编程 OpenAPI 的基本能力。
说明
工具介绍
扣子编程 API Playground 主要提供以下功能：
- 可视化调试 API：支持在线可视化调试 API。只需根据页面提示填入必选参数，即可快速构建一个有效的 API 请求。API Playground 可以在线运行这个请求，并展示 API 的响应信息。
- API 文档：开发者可以在 API Playground 中快速查看 API 文档，文档中可视化展示 API 接口说明、请求参数说明，便于开发者理解参数结构。
- 示例代码：扣子编程支持 Python、JavaScript 等多种主流开发语言的 SDK，可简单便捷地调用扣子编程 OpenAPI。对于发起对话和工作流相关 API，扣子编程提供多语言 SDK 示例代码供开发者参考，提高编程效率。
模块介绍
API Playground 工具的各个模块如下：
各区域说明如下：
|
编号 |
区域 |
说明 |
|---|---|---|
|
① |
OpenAPI 列表 |
扣子编程 OpenAPI 列表。 |
|
② |
OpenAPI 基本信息 |
指定 OpenAPI 的基本信息，包括 OpenAPI 名称、请求方式、接口说明及注意事项。 |
|
③ |
请求参数 |
展示此 API 的请求参数，其中标记星号（*）的参数为必选参数。具体的参数说明可以单击展开全部来查看。 |
|
返回参数 |
展示此 API 的返回参数。具体的参数说明可以单击展开按钮来查看。 |
|
|
运行记录 |
展示所在套餐的版本内，最近 7 天近 5 条的 Playground 运行记录。 |
|
|
④ |
示例代码 |
OpenAPI 对应的示例代码。 |
探索 API Playground
说明
执行以下操作前，请确认你已获取了一个生效中的访问令牌。API Playground 支持个人访问令牌或 OAuth Token。
- 登录 API Playground。
- 在左侧 OpenAPI 列表中，选择需要调用的 OpenAPI。
说明
- API 目录树默认为隐藏状态，当鼠标悬停在左侧导航栏与 Playground 页面的接缝处时，会自动显示 API 目录树。
- 若需固定显示 API 目录树，单击目录右侧的固定，将其固定在 Playground 页面的左侧。
- 在请求参数区域填写必选的请求参数。
- 在右侧示例代码区域，单击运行。
- 在页面右下角查看返回结果。
体验 SDK
你可以在 Playground 中体验 Chat SDK、Web SDK、Real-time Chat SDK 的能力。本文以 Chat SDK 为例，介绍具体的操作步骤。Real-time Chat SDK的详细步骤和参数说明请参见体验智能音视频 Demo。
- 登录 API Playground。
- 在左侧导航栏中选择 SDK > Chat SDK。
- 在请求配置或代码编辑区配置相关参数，详细的参数说明请参见安装并使用 Chat SDK，单击运行。单击右下角的悬浮球。
- 在聊天窗口中体验智能体或扣子应用的功能。
常见问题
API Playground是否收费？
API Playground 免收 Playground 的功能使用费。但是如果账号调用了涉及模型处理的 API，则会产生费用。例如用户通过 API Playground 调用发起对话 API，会收取智能体调用次数的费用、火山方舟 Token 的费用。关于费用的详细说明可参考计费概述。
API Playground 免收 Playground 的功能使用费。但是如果你调用了涉及模型处理或收费插件的 API，则会消耗 Coze 账号中的 Coze Token。关于费用的详细说明可参考计费概述。
为什么看不到 Python 等语言的示例代码？
目前仅以下接口支持查看 Python 等场景开发语言的示例代码。
对于发起对话接口，API Playground 提供流式响应、非流式响应、涉及端插件的响应等多种场景的示例代码供开发者参考和复制。
中国大陆以外的地区可以访问扣子 API 吗
api.coze.cn 是扣子编程 OpenAPI 的统一访问域名，支持全球各个地区访问，在中国大陆以外的国家或者地区访问 api.coze.cn 的时候，扣子编程会提供一条高速通道，将这些用户的请求快速回源到中国大陆服务器。
目前支持将请求快速回源到中国大陆的国家或者地区有：美国、新加坡、香港。