> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coze.cn/llms.txt
> Use this file to discover all available pages before exploring further.

API Playground 是扣子编程提供的在线 API 调试工具，集成了扣子编程所有 OpenAPI，支持可视化调试 API、查看帮助文档、示例代码，帮助开发者快速体验扣子编程 OpenAPI 的基本能力。
:::tip 说明
* API Playground 使用真实的线上数据，通过 Playground 调用创建、修改或删除数据的 API 时，请务必谨慎操作。
* 扣子付费套餐用户调用[发起对话](/developer_guides/chat_v3)等涉及模型处理的 API 时，会产生一定的费用。关于费用的详细说明可参考[计费概述](/coze_pro/billing_overview)。
:::
## 工具介绍 {#4695f4fd}
扣子编程 API Playground 主要提供以下功能：

* **可视化调试 API**：支持在线可视化调试 API。只需根据页面提示填入必选参数，即可快速构建一个有效的 API 请求。API Playground 可以在线运行这个请求，并展示 API 的响应信息。
* **API 文档**：开发者可以在  API Playground 中快速查看 API 文档，文档中可视化展示 API 接口说明、请求参数说明，便于开发者理解参数结构。
* **示例代码**：扣子编程支持 Python、JavaScript 等多种主流开发语言的 SDK，可简单便捷地调用扣子编程 OpenAPI。对于[发起对话](/developer_guides/chat_v3)和工作流相关 API，扣子编程提供多语言 SDK 示例代码供开发者参考，提高编程效率。

## 模块介绍 {#a289dd25}
API Playground 工具的各个模块如下：
![Image=700x576](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/c33bd0ada757402c9d9c2a04d7c87bc5~tplv-goo7wpa0wc-image.image)
各区域说明如下：
<!-- @cols-width: 114,215,538 -->
| | | | \
|**编号** |**区域** |**说明** |
|---|---|---|
| | | | \
|① |OpenAPI 列表 |扣子编程 OpenAPI 列表。 |\
| | |单击 OpenAPI 名称，可直接跳转到对应的调试页面。 |
| | | | \
|② |OpenAPI 基本信息 |指定 OpenAPI 的基本信息，包括 OpenAPI 名称、请求方式、接口说明及注意事项。 |
| | | | \
|③ |请求参数 |展示此 API 的请求参数，其中标记星号（*）的参数为必选参数。具体的参数说明可以单击**展开全部**来查看。 |\
| | |其中，token 是必填的 Header 请求参数。测试或调试场景下，可以使用个人访问令牌快速发起一个 API 请求，详细说明可参考[添加个人访问令牌](/developer_guides/pat)；正式线上环境建议使用 OAuth 鉴权方式，详细说明可参考[OAuth 应用管理](/developer_guides/oauth_apps)。 |
|^^| | | \
| |返回参数 |展示此 API 的返回参数。具体的参数说明可以单击**展开**按钮来查看。 |
|^^| | | \
| |运行记录 |展示所在套餐的版本内，最近 7 天近 5 条的 Playground 运行记录。 |
| | | | \
|④ |示例代码 |OpenAPI 对应的示例代码。 |\
| | |填写参数后，单击**运行**。扣子编程对你填写的 token 进行鉴权后，会向该接口发起一个真实的线上请求，同时展示请求结构、响应内容等相关信息。 |\
| | |对于[发起对话](/developer_guides/chat_v3)和工作流相关接口，你还可以查看和复制各种语言版本下的示例代码，快速接入更语言的 SDK。 |

## 探索 API Playground {#6f2459ef}
:::tip 说明
执行以下操作前，请确认你已获取了一个生效中的访问令牌。API Playground 支持个人访问令牌或 OAuth Token。
:::

1. 登录 [API Playground](https://code.coze.cn/playground)。
2. 在左侧 OpenAPI 列表中，选择需要调用的 OpenAPI。
   :::tip 说明
   * API 目录树默认为隐藏状态，当鼠标悬停在左侧导航栏与 Playground 页面的接缝处时，会自动显示 API 目录树。
   * 若需固定显示 API 目录树，单击目录右侧的**固定**，将其固定在 Playground 页面的左侧。
      ![Image=150x177](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/f250e7c914b544b388cd92772b0a2015~tplv-goo7wpa0wc-image.image)
   :::
3. 在请求参数区域填写必选的请求参数。
   ![Image=300x408](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/86ff89aba1514c5ab206f921eb9d3229~tplv-goo7wpa0wc-image.image)
4. 在右侧示例代码区域，单击**运行**。
   ![Image=600x331](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/f2bdc178d2b847388160ad11dc1b7aa4~tplv-goo7wpa0wc-image.image)
5. 在页面右下角查看返回结果。
   ![Image=600x445](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/02a69bbbe18644829175a097573d537b~tplv-goo7wpa0wc-image.image)

## 体验 SDK {#40e10605}
你可以在 Playground 中体验 Chat SDK、Web SDK、Real-time Chat SDK 的能力。本文以 Chat SDK 为例，介绍具体的操作步骤。Real-time Chat SDK的详细步骤和参数说明请参见[体验智能音视频 Demo](/dev_how_to_guides/realtime_playground)。

1. 登录 [API Playground](https://code.coze.cn/playground)。
2. 在左侧导航栏中选择 **SDK** > **Chat SDK**。
3. 在**请求配置**或**代码编辑区**配置相关参数，详细的参数说明请参见[安装并使用 Chat SDK](/developer_guides/install_web_sdk)，单击**运行**。单击右下角的悬浮球。
   ![Image=600x481](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/61a596558d5f40119f0cb0c1fe7787c4~tplv-goo7wpa0wc-image.image)
4. 在聊天窗口中体验智能体或扣子应用的功能。
   ![Image=600x484](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/63b9c9053df14754a72e4657b598c567~tplv-goo7wpa0wc-image.image)

## 常见问题 {#7c767946}
### API Playground是否收费？ {#d4e18727}
API Playground 免收 Playground 的功能使用费。但是如果账号调用了涉及模型处理的 API，则会产生费用。例如用户通过 API Playground 调用[发起对话](/developer_guides/chat_v3) API，会收取智能体调用次数的费用、火山方舟 Token 的费用。关于费用的详细说明可参考[计费概述](/coze_pro/billing_overview)。
API Playground 免收 Playground 的功能使用费。但是如果你调用了涉及模型处理或收费插件的 API，则会消耗 Coze 账号中的 Coze Token。关于费用的详细说明可参考[计费概述](/coze_pro/billing_overview)。
### 为什么看不到 Python 等语言的示例代码？ {#1112c87f}
目前仅以下接口支持查看 Python 等场景开发语言的示例代码。

* [发起对话](/developer_guides/chat_v3)
* [执行工作流](/developer_guides/workflow_run)
* [执行工作流（流式响应）](/developer_guides/workflow_stream_run)

对于[发起对话](/developer_guides/chat_v3)接口，API Playground 提供流式响应、非流式响应、涉及端插件的响应等多种场景的示例代码供开发者参考和复制。
### 中国大陆以外的地区可以访问扣子 API 吗 {#cdae1929}
`api.coze.cn` 是扣子编程 OpenAPI 的统一访问域名，支持全球各个地区访问，在中国大陆以外的国家或者地区访问 `api.coze.cn` 的时候，扣子编程会提供一条高速通道，将这些用户的请求快速回源到中国大陆服务器。
目前支持将请求快速回源到中国大陆的国家或者地区有：美国、新加坡、香港。