Coze API接口实战应用

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，了解从注册到实际调用的全过程，并掌握其在不同场景下的应用，以充分发挥Coze平台的潜能。