Bug: 查询工作流基本信息 api缺失

[QHSsss]

工作流的基本信息 这个接口是不是忘记加上去了？

[coze-js-bot[bot]]

正在帮您查询中，请稍等...

根据用户反馈的“工作流基本信息接口缺失”问题，结合扣子开放平台的官方文档，以下是具体分析和解决方案：

问题分析

用户提到的“工作流基本信息接口”实际已存在，官方文档中明确提供了 「查询工作流基本信息」接口，可能因SDK未封装或文档未被正确引用导致误解。具体接口信息如下：

解决方案

1. 使用官方「查询工作流基本信息」接口

• 接口功能：获取单个工作流的详细信息（名称、描述、创建者、更新时间等）。

• 请求方式：GET

• 请求地址：https://api.coze.cn/v1/workflows/:workflow_id
  （需将 :workflow_id 替换为实际工作流ID）

• 权限要求：访问令牌需包含 getMetaData 权限。

• 请求头示例：

  Authorization: Bearer {access_token}
  Content-Type: application/json
  

• 返回示例：

  {
    "code": 0,
    "data": {
      "workflow_id": "73505836754923***",
      "workflow_name": "示例工作流",
      "description": "用于测试的工作流",
      "creator": {
        "id": "2478774393",
        "name": "用户名称"
      },
      "created_at": "1700000000",
      "updated_at": "1701234567"
    },
    "msg": "Success"
  }
  

• 参考文档：
  查询工作流基本信息

2. 若需批量获取工作流列表

若用户需要获取多个工作流的基本信息，可使用 「查询工作流列表」接口：

• 请求地址：https://api.coze.cn/v1/workflows
• 请求参数：需传入 workspace_id、page_num 等分页参数。
• 参考文档：
  查询工作流列表

3. SDK实现建议

若用户使用的 coze-js SDK未封装上述接口，可通过以下方式解决：

• 手动调用REST API：直接使用HTTP客户端（如Axios）发送请求，示例代码：

  const axios = require('axios');
  const accessToken = 'your_access_token';
  const workflowId = 'your_workflow_id';
  
  axios.get(`https://api.coze.cn/v1/workflows/${workflowId}`, {
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    }
  })
  .then(response => console.log(response.data))
  .catch(error => console.error(error));
  

• 反馈SDK问题：在 coze-dev/coze-js 仓库提交issue，请求补充接口封装。

注意事项

• 权限验证：确保访问令牌已开通 getMetaData 权限（参考 鉴权方式）。
• 工作流状态：接口仅支持查询 已发布 的工作流，未发布的工作流会返回 4200 错误码。
• URL转换：文档链接需将 api.open/docs 替换为 open/docs 方可访问。

总结

官方已提供「查询工作流基本信息」接口，用户可直接通过REST API调用或推动SDK更新。若仍存在问题，建议检查权限配置或工作流状态，并参考官方文档调试。

参考链接：
查询工作流基本信息
查询工作流列表
鉴权方式概述> 正在帮您查询中，请稍等...

根据用户反馈的“工作流基本信息接口缺失”问题，结合扣子开放平台的官方文档，以下是具体分析和解决方案：

问题分析

用户提到的“工作流基本信息接口”实际已存在，官方文档中明确提供了 「查询工作流基本信息」接口，可能因SDK未封装或文档未被正确引用导致误解。具体接口信息如下：

解决方案

1. 使用官方「查询工作流基本信息」接口

• 接口功能：获取单个工作流的详细信息（名称、描述、创建者、更新时间等）。

• 请求方式：GET

• 请求地址：https://api.coze.cn/v1/workflows/:workflow_id
  （需将 :workflow_id 替换为实际工作流ID）

• 权限要求：访问令牌需包含 getMetaData 权限。

• 请求头示例：

  Authorization: Bearer {access_token}
  Content-Type: application/json
  

• 返回示例：

  {
    "code": 0,
    "data": {
      "workflow_id": "73505836754923***",
      "workflow_name": "示例工作流",
      "description": "用于测试的工作流",
      "creator": {
        "id": "2478774393",
        "name": "用户名称"
      },
      "created_at": "1700000000",
      "updated_at": "1701234567"
    },
    "msg": "Success"
  }
  

• 参考文档：
  查询工作流基本信息

2. 若需批量获取工作流列表

若用户需要获取多个工作流的基本信息，可使用 「查询工作流列表」接口：

• 请求地址：https://api.coze.cn/v1/workflows
• 请求参数：需传入 workspace_id、page_num 等分页参数。
• 参考文档：
  查询工作流列表

3. SDK实现建议

若用户使用的 coze-js SDK未封装上述接口，可通过以下方式解决：

• 手动调用REST API：直接使用HTTP客户端（如Axios）发送请求，示例代码：

  const axios = require('axios');
  const accessToken = 'your_access_token';
  const workflowId = 'your_workflow_id';
  
  axios.get(`https://api.coze.cn/v1/workflows/${workflowId}`, {
    headers: {
      'Authorization': `Bearer ${accessToken}`,
      'Content-Type': 'application/json'
    }
  })
  .then(response => console.log(response.data))
  .catch(error => console.error(error));
  

• 反馈SDK问题：在 coze-dev/coze-js 仓库提交issue，请求补充接口封装。

注意事项

• 权限验证：确保访问令牌已开通 getMetaData 权限（参考 鉴权方式）。
• 工作流状态：接口仅支持查询 已发布 的工作流，未发布的工作流会返回 4200 错误码。
• URL转换：文档链接需将 api.open/docs 替换为 open/docs 方可访问。

总结

官方已提供「查询工作流基本信息」接口，用户可直接通过REST API调用或推动SDK更新。若仍存在问题，建议检查权限配置或工作流状态，并参考官方文档调试。

参考链接：
查询工作流基本信息
查询工作流列表
鉴权方式概述{"msg_type":"empty result","data":"empty result","from_module":null,"from_unit":null}{"msg_type":"generate_answer_finish","data":"","from_module":null,"from_unit":null}{"msg_type":"generate_answer_finish","data":"{"finish_reason":0,"FinData":""}","from_module":null,"from_unit":null}