官网文档:https://www.coze.cn/docs/developer_guides/coze_api_overview
所有在 API 接口调用产生的问题均在此文档中汇集,目前主要包含
- 确认接口服务可用性
- 常见组合接口使用介绍
!!!请在此阶段之前确认智能体在调试界面是正常运行且及时发布的
确认接口服务是否可用
常规排查步骤
-
确认接口服务可用:使用自身创建的智能体、令牌和官网文档的接口demo测试接口服务可用
-
检查业务代码请求:在客户端进行接口请求前,请使用接口工具测试您的请求是内容正确的。以便您区分代码问题和请求内容问题。
-
如有请求内容问题,请参考官网demo进行调整。如您确认内容无误仍有报错,请前往售后提单解决您的问题。
参数字段描述不清晰
接口测试示例
Step 1:确认令牌可用
令牌需开通对应权限:https://www.coze.cn/open/oauth/pats
Bot的创建者与令牌归属同一账号
请求方式 | POST |
---|---|
请求地址 | ``` |
https://api.coze.cn/v3/chat |
| **权限** | chat确保调用该接口使用的个人令牌开通了 chat 权限,详细信息参考[鉴权方式](https://www.coze.cn/docs/developer_guides/authentication)。 |
| **接口说明** | 调用此接口发起一次对话,支持添加上下文和流式响应。 |
### Step 2:快速接口体验
编辑curl命令:
- 选择文档右侧的示例
- 根据需要选择问答类型
- 替换包含******的参数
- 调整url中的相关参数。因本次对话为新建对话,不需要传入conversation id ,需调整url删除相关内容
- 复制文本内容
![picture.image](https://p3-volc-community-sign.byteimg.com/tos-cn-i-tlddhu82om/57c78148886843abac4a65c48d8bdf46~tplv-tlddhu82om-image.image?=&rk3s=8031ce6d&x-expires=1737273260&x-signature=QUfFGtJGMh52BFcwPnfmIn5O0DI%3D)
使用curl 命令
![picture.image](https://p3-volc-community-sign.byteimg.com/tos-cn-i-tlddhu82om/174b7fb60ac24c23990f73e023cda4cd~tplv-tlddhu82om-image.image?=&rk3s=8031ce6d&x-expires=1737273260&x-signature=%2B7QJTr55W5s12mYzEMPvCwLtY64%3D)
使用postman (接口测试阶段推荐使用)
![picture.image](https://p3-volc-community-sign.byteimg.com/tos-cn-i-tlddhu82om/46c492953cf346d2b334ee8d20db16d7~tplv-tlddhu82om-image.image?=&rk3s=8031ce6d&x-expires=1737273260&x-signature=eOyi8PBC6%2F9yF%2F%2F7fXXYiomTI2o%3D)
### Step 3:查看返回内容
![picture.image](https://p3-volc-community-sign.byteimg.com/tos-cn-i-tlddhu82om/c004a441f7c4434bb1a1368f87a2b135~tplv-tlddhu82om-image.image?=&rk3s=8031ce6d&x-expires=1737273260&x-signature=AlCNTxZyHOKrA5177lDRxNSBQMc%3D)