助手
扣子 AI 帮助与支持
你好,我是 扣子 文档问答助手 🎉 你在阅读当前文档的过程中,无论对文档概念的解释,还是文档内容方面的疑问,都可以随时向我提问,我会全力为你解答
推荐问题
扣子 3.0 都有什么新特性?
扣子和扣子编程有什么区别?
扣子如何收费?
文档反馈
低代码项目
快速开始
智能体
工作流
应用
资源
发布
模型
多人协作
开发工具
Coze CLI
API 参考
鉴权
智能体和应用
工作空间
文件夹
企业/组织
会话与消息
对话
工作流
文件
智能音视频
知识库
数据库
插件
变量
渠道
用量限额
账单与权益
回调
API 教程
SDK 参考
音视频
推广与变现

准备工作

在调用扣子 API 前,确保你已经将低代码智能体发布为了 API 服务,并通过不同的授权方式获取了访问令牌。

发布低代码智能体为 API 服务

低代码智能体发布为 API 服务之后,才能通过调用 API 的方式使用这个智能体,例如查看智能体的基本设置、发起一个智能体对话等。
操作步骤如下:

  1. 登录扣子编程
  2. 在页面顶部空间列表中选择目标工作空间。
  3. 项目开发页面,选择低代码智能体。
  4. 在页面右上角,单击发布
  5. 发布页面,选择 API 选项,然后单击发布
    Image

获取访问令牌

调用扣子 API 时,你需要在 Header 中通过 Authorization 参数指定访问令牌(Access token),扣子服务端会根据访问令牌验证调用方的操作权限。调用 API 之前,你需要先获得访问令牌。
扣子编程支持以下三种访问令牌,详细说明可参考鉴权方式概述

  • 个人访问令牌:通过控制台生成的访问令牌,有效期一天以上,使用简单便捷,适用于测试场景。你可以随时调整令牌权限和有效期,到期后需要重新生成。
  • 服务访问令牌:通过控制台生成的访问令牌,是以服务身份创建的访问凭证,可长期有效访问扣子编程资源,通常用于服务/应用程序的身份验证和授权。SAT 与 OAuth JWT 鉴权方式相比,具有更长的有效期(可设置为永久有效),操作简单,能够有效简化授权流程。
  • OAuth 访问令牌:通过 OAuth 2.0 授权流程生成的访问令牌,有效期为分钟级别,安全性较高,适用于线上生产环境。获取 OAuth 访问令牌的方式和流程可参考 OAuth 应用管理

本文档以生成个人访问令牌为例,演示获取访问令牌的方式。

  1. 登录扣子编程

  2. 在左侧导航栏选择 API & SDK

  3. 扣子 API 页面的顶部单击授权 > 个人访问令牌页签。
    Image

  4. 在右上角单击添加

  5. 添加新的个人访问令牌页面完成以下配置,然后单击确定

    配置项

    说明

    名称

    个人访问令牌的名称。

    过期时间

    个人访问令牌的有效期时长。令牌过期后将会失效,无法继续用它来调用扣子 API。
    生成令牌后,无法修改过期时间。

    权限

    个人访问令牌的权限。
    调用 API 时,个人访问令牌应具备对应的 API 权限,否则报错 4101。

    访问团队空间

    可以使用该令牌的空间。

    说明

    • 扣子企业版(企业标准版、企业旗舰版):成员可以选择本组织中,本人创建或加入的某个工作空间,或目前和将来创建或加入的所有工作空间。超级管理员和管理员可以选择本组织中所有工作空间。
    • 扣子个人版:仅支持选择你作为空间所有者的工作空间,或目前和将来创建的所有工作空间,不支持选择你作为成员加入的空间。
  6. 复制并妥善保存个人访问令牌。
    生成的令牌仅在此时展示一次,请即刻复制并保存。