Coze-AI智能体开发平台5-Coze的API与SDK

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

---

前言

1. API参考

Coze⽀持将 AI 智能体和扣⼦应⽤发布为 API （Application Programming Interface 应⽤程序编
程接⼝）服务，你可以通过 HTTP ⽅式与其进⾏交互。有编程基础的情况下，能够给⽤⼾更多的⾃定义开发空间。

1.1 令牌鉴权

扣⼦ API 通过访问令牌（Access Token）进⾏ API 请求的鉴权。所有的 API 请求都必须在请求头
的 Authorization 参数中包含你的访问令牌（Access Token）。

我们重点学习个⼈访问令牌（PAT）
个人访问令牌

1.2 API Playground

API Playground 是扣⼦提供的在线 API 调试⼯具，集成了扣⼦所有 OpenAPI，⽀持可视化调试 API、查看帮助⽂档、⽰例代码，帮助开发者快速体验扣⼦ OpenAPI 的基本能⼒。

扣⼦ API Playground 主要提供以下功能：
• 可视化调试 API：⽀持在线可视化调试 API。只需根据⻚⾯提⽰填⼊必选参数，即可快速构建⼀个
有效的 API 请求。API Playground 可以在线运⾏这个请求，并展⽰ API 的响应信息。
• API ⽂档：开发者可以在 API Playground 中快速查看 API ⽂档，⽂档中可视化展⽰ API 接⼝说
明、请求参数说明，便于开发者理解参数结构。
• ⽰例代码：扣⼦⽀持 Python、JavaScript 等多种主流开发语⾔的 SDK，可简单便捷地调⽤扣⼦
OpenAPI
API Playground

比如调用这个接口
token填写我们自己的个人访问token

1.3 核⼼API

扣⼦接⼝⽂档

1.4 ⼯作空间API

1.4.1 查看空间列表

请求⽅式： GET
请求地址： https://api.coze.cn/v1/workspaces

查看空间列表

1.4.2 查看空间成员列表

workspace_id这个必填
就是空间id

1.5 智能体与应用API

1.5.1 查看智能体列表

查看智能体列表

智能体状态选择：所有

1.5.2 查看应⽤列表

1.5.3 查看智能体配置

注意没有发布的智能体，不能查看配置信息

1.6 对话API

1.6.1 发起对话

用户id就是我自己

这个id就是chat_id
id:7568864294126174259
conversation_id:7568864294126141491

1.6.2 查看对话详情

1.6.3 查看对话消息

1.7 工作流API

1.7.1 查看⼯作流列表

应用里面的工作流也算

1.7.2 执⾏⼯作流

2. SDK参考

2.1 什么是SDK ？

sdk（Software Development Kit - 软件开发⼯具包）由平台⽅提供给开发者的⼀个“⼀站式⼯具
包”，⾥⾯包含了创建该平台应⽤所必需的代码库、⼯具、说明书和规范。
我们前⾯学习了扣⼦的部分主要API，为什么还要学习SDK呢？因为相⽐较与API，SDK使⽤起来更加⽅便！！！
⽐如：你想做⼀道正宗的⿇婆⾖腐。
API就相当于⿇婆⾖腐的菜谱—》不受语言限制
SDK就相当于⿇婆⾖腐料理包–>受语言限制

我们使用python SDK
COZE的Python的SDK

pip install cozepy

2.2 创建COZE客户端

创建文件**.env**存储环境变量，比如用户的访问token

COZE_API_TOKEN = xxxxx

然后是py文件

#导入功能模块
import osfrom cozepy import Coze,TokenAuth,COZE_CN_BASE_URL#获取工作空间的列表
def get_space_list():#声明访问令牌api_token = os.environ.get("COZE_API_TOKEN")if not api_token:print("请先设置令牌")#初始化coze客户端coze = Coze(#声明令牌auth=TokenAuth(token=api_token),#声明域名-->是我们国内访问的url--》https://api.coze.cnbase_url=COZE_CN_BASE_URL)

2.3 查看工作空间列表

pip install python-dotenv

from dotenv import load_dotenv
load_dotenv()

核心作用是 加载项目中的 .env 配置文件，把文件里的环境变量（比如密钥、数据库地址等敏感信息）读进 Python 的系统环境，方便后续用 os.getenv() 安全获取，不用硬写在代码里。

#导入功能模块
import osfrom cozepy import Coze,TokenAuth,COZE_CN_BASE_URL
#加载环境变量
from dotenv import load_dotenv
load_dotenv()#获取工作空间的列表
def get_space_list():#声明访问令牌api_token = os.environ.get("COZE_API_TOKEN")if not api_token:print("请先设置令牌")#初始化coze客户端coze = Coze(#声明令牌auth=TokenAuth(token=api_token),#声明域名-->是我们国内访问的url--》https://api.coze.cnbase_url=COZE_CN_BASE_URL)#创建好coze客户端之后，就可以进行调用了try:spaces = coze.workspaces.list()if hasattr(spaces, "items"):  #如果spaces有属性itemsspaces = spaces.itemsprint(spaces)except Exception as e:print("访问空间列表失败: {str(e)}")if __name__ == "__main__":get_space_list()

总结