Coze API接口实战应用

Coze API作为Coze平台对外的桥梁，让开发者能够灵活地利用Coze的功能和服务，促进业务流程自动化和系统集成。它覆盖了从数据获取到智能交互的全方位功能，旨在提升工作效率和创造更多可能。

Coze API申请接入流程

1. 发现API

通过API HUB查找AI相关API，找到Coze API并跳转访问Coze官方网站，注册开发者账号，填写必要的个人信息和公司信息。

2. 创建应用与密钥

登录到首页后创建Bot

打开API令牌管理页面添加新令牌

3. API配置

在个人访问令牌界面，配置所需API接口权限。

Coze API的使用限制

当前扣子 API 免费供开发者使用，每个空间的 API 请求限额如下：

QPS (每秒发送的请求数)：2

QPM (每分钟发送的请求数)：60

QPD (每天发送的请求数)：3000

Coze API调用过程

发起对话

请求地址

POST https://api.coze.cn/open_api/v2/chat

curl --location --request POST 'https://api.coze.cn/open_api/v2/chat' \
--header 'Authorization: Bearer {{Personal_Access_Token}}' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Host: api.coze.cn' \
--header 'Connection: keep-alive' \
-d '{
    "conversation_id": "123",
    "bot_id": "{{Bot_Id}}",
    "user": "29032201862555",
    "query": "hello",
    "stream":flase
}'

{{Personal_Access_Token}}替换为前面申请的令牌

进入 Bot 的开发页面，开发页面 URL 中 bot 参数后的数字就是 Bot ID。例如https://www.coze.cn/space/73428668341****/bot/73428668*****，bot ID 为73428668*****。

示例

同时支持流式返回，仅需将stream参数置为ture

Coze API的响应

data:{"event":"message","message":{"role":"assistant","type":"answer","content":"Hello","content_type":"text","extra_info":null},"is_finish":false,"index":0,"conversation_id":"123"}

data:{"event":"message","message":{"role":"assistant","type":"answer","content":"!","content_type":"text","extra_info":null},"is_finish":false,"index":0,"conversation_id":"123"}

...

data:{"event":"message","message":{"role":"assistant","type":"answer","content":"","content_type":"text","extra_info":null},"is_finish":true,"index":0,"conversation_id":"123"}

data:{"event":"done"}

Coze API的协议和格式

Coze的API使用HTTPS协议，返回值为JSON格式。支持流式和非流式数据返回

快速开始

使用预构建的程序– 选择一个预构建的机器人模板可以帮助您快速启动和运行。
构建并发布你的第一个机器人
- 构建机器人：按照详细步骤，选择适合的功能，如多代理模式和工作流程模式，使用大型语言模型和记忆功能。
- 发布：在完成构建后，选择不同的发布渠道，如Discord、Telegram、Instagram、Messenger、Slack、LINE，以及Lark。

功能概览

多代理模式
- 允许你同时运行多个代理，提高工作效率。
工作流模式
- 配置自动化工作流程，简化复杂任务。
记忆功能
- 使用记忆功能来存储和管理对话历史。

发布渠道

发布到社交平台– 你的机器人可以发布到多个社交平台，确保广泛覆盖。支持的平台包括：
- Discord
- Telegram
- Instagram
- Messenger
- Slack
- LINE
- Lark
发布到商店
- 将机器人发布到商店，并了解如何让你的机器人出现在“推荐”列表中。

Coze API有哪些常见问题？

1. Coze API是什么？

A: Coze API是Coze平台提供的一种接口服务，它允许开发者通过编程方式与Coze平台上的AI Bot进行交互。使用Coze API，可以发起对话、管理消息、上传和管理知识库内容，以及使用各种内置插件和工作流功能。

2. 如何使用Coze API？

A: 使用Coze API首先需要在Coze平台注册开发者账号并创建应用以获取API密钥。然后根据API文档的指引，配置API请求的权限和参数。接下来，通过HTTPS协议发送请求，并以JSON格式接收响应数据。

3. Coze API有哪些使用限制？

A: Coze API对于每个账号的请求限额有明确的规定，例如每秒请求数（QPS）、每分钟请求数（QPM）和每天请求数（QPD）的限制。超出限额可能导致无法继续使用API服务。

4. Coze API支持哪些功能？

A: Coze API支持包括但不限于发起对话、消息管理、知识库管理、插件工具使用、数据库和变量管理、定时任务设置、工作流配置以及多Agent模式等功能。

5. 如何将Coze Bot发布到微信公众号？

A: 将Coze Bot发布到微信公众号，需要在Coze平台的Bot编辑页面进行发布操作，选择微信公众号作为发布渠道，并输入公众号的APPID完成授权和绑定。

6. Coze API的响应格式是怎样的？

A: Coze API使用HTTPS协议，并且返回数据通常为JSON格式。同时，API支持流式和非流式数据返回，具体取决于请求的参数配置。

7. 如果我想自己开发Coze插件，应该怎么做？

A: 如果你想自己开发Coze插件，需要具备相应的编程能力，并根据Coze平台提供的插件开发文档进行操作。开发完成后，可以在Coze平台上进行插件的测试和发布。

8. Coze API是否提供免费使用额度？

A: 是的，Coze API为注册用户提供了免费额度，包括API服务和SDK服务的免费额度。超出免费额度后，可能需要购买额外的Coze Token来继续使用服务。

9. Coze API有哪些常见的问题和解决方案？

A: 常见的问题可能包括授权失败、请求限额超出、配置错误等。解决方案通常涉及检查授权令牌、减少请求频率、重新检查配置步骤等。如果遇到问题，可以查阅Coze官方文档或在Coze社区寻求帮助。

Coze API使用场景案例有哪些？

本文详细列举了Coze API可以灵活运用的使用场景：

社交媒体分析助手：利用Coze API，可以开发一个社交媒体分析助手，该助手能够连接到Twitter等社交媒体平台的API，实时监测社交平台的主要趋势。它能够对采集的数据进行分析以识别热点和关键词，识别并追踪在推特上的热门话题和流行模式，并根据数据分析模型，预测未来可能出现的热点和趋势。
智能客服系统：通过Coze API，可以创建一个智能客服系统，该系统能够理解客户的问题并提供准确的答案。它可以集成到公司的网站或应用程序中，以提高客户服务效率和质量。智能客服系统可以24小时工作，提供即时的客户支持，从而提升客户满意度。
个性化新闻推荐：使用Coze API开发的个性化新闻推荐系统能够根据用户的兴趣和阅读历史，推荐相关的新闻和文章。该系统可以通过分析用户的阅读习惯和偏好，使用机器学习算法来提供个性化的新闻内容，让用户能够更有效地获取感兴趣的信息。
虚拟会议情绪分析：在虚拟会议中，Coze API可以集成到会议软件中，实时分析参与者的面部表情和语音语调，以识别他们的情绪状态。这样，会议组织者可以根据参与者的情绪反馈调整会议内容和节奏，提高会议的互动性和参与度。
游戏难度调整： Coze API可以用于视频游戏中，根据玩家的面部表情和情绪状态调整游戏难度。例如，如果系统检测到玩家感到沮丧或困惑，可以自动降低游戏难度或提供游戏提示，以提高玩家的游戏体验。
智能写作助手：利用Coze API开发的智能写作助手能够帮助用户提高写作效率和质量。它可以提供语法检查、文本改写、内容建议等功能，帮助用户改进他们的写作。此外，智能写作助手还可以根据用户写作的主题提供相关的信息和数据，丰富写作内容。

本指南旨在帮助开发者快速上手Coze API，了解从注册到实际调用的全过程，并掌握其在不同场景下的应用，以充分发挥Coze平台的潜能。