API 介绍

扣子编程是新一代一站式 AI 智能体开发平台。无论你是否有编程基础，都可以在平台上快速搭建基于 AI 模型的各类问答智能体。而且你可以将搭建的智能体发布到各类社交平台和通讯软件上，让更多的用户与你搭建的智能体聊天。
扣子编程支持将 AI 智能体和扣子应用发布为 API 服务，你可以通过 HTTP 方式与其进行交互。

费用说明

• 个人免费版：免费使用扣子编程 API，但有一定的额度限制。
• 个人付费版（进阶版、高阶版、旗舰版）、企业版（企业标准版、企业旗舰版）：涉及大模型处理的 API 会产生模型费用，音视频的 API 也有对应功能的计费方式。

限制说明

限流策略

扣子编程 API 限流策略分为以下两个维度，且不同用户类型的限流策略不同。

请求体限制

API 请求体大小限制如下：

• 工作流相关的 API 请求体大小限制为 20MB。
• 其他类类别的 API 请求体大小限制为 15MB。

发送请求

将以下命令粘贴到终端中以运行你的第一个 API 请求。
在发送请求前，请将示例中的以下参数值替换成真实数据：

• Authorization：生成的个人访问令牌。线上环境注意替换为 OAuth 访问密钥，详情参考OAuth 应用管理。

• bot_id：智能体ID。进入智能体的开发页面，开发页面 URL 中 bot 参数后的数字就是智能体ID。例如https://www.coze.cn/space/341****/bot/73428668*****，bot_id 为73428668*****。

  说明

  确保智能体已发布为 API 服务。详情参考准备工作。

• user_id：标识当前与智能体交互的用户。调试时可将此参数固定为一个任意字符串，例如 123。

• content：发送的消息内容。

  curl --location --request POST 'https://api.coze.cn/v3/chat' \
  --header 'Authorization: Bearer pat_OYDacMzM3WyOWV3Dtj2bHRMymzxP****' \
  --header 'Content-Type: application/json' \
  --data-raw '{
      "bot_id": "73428668*****",
      "user_id": "123123***",
      "stream": false,
      "auto_save_history":true,
      "additional_messages":[
          {
              "role":"user",
              "content":"早上好",
              "content_type":"text"
          }
      ]
  }'
  

  说明

  如果需要通过火山引擎私有网络访问扣子编程 API ，请参见通过私网连接访问扣子 API。

基础概念