第七部分,开放 API 与 Chat SDK

工作流 API 调用

通过 /v1/workflow/run 运行已发布工作流,校验参数、结果、超时和幂等性。

核心认识

工作流 API 适合从服务端触发确定性流程。调用方应按发布版本构造参数,验证输出字段,并为外部副作用设计幂等键。

  • 调用前确认工作流已发布到 API 渠道。
  • 参数与工作流开始节点契约一致。
  • 结果解析不依赖自然语言格式。
  • 写入、发送和付款类节点处理重复请求。

操作方法

  1. 记录 workflow_id 和输入 Schema。
  2. 用最小参数调用同步接口。
  3. 验证正常、缺参和外部服务失败。
  4. 加入超时、重试和调用追踪。
bash
curl --request POST "$COZE_API_HOST/v1/workflow/run" \
  --header "Authorization: Bearer $COZE_ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"workflow_id":"WORKFLOW_ID","parameters":{"query":"测试"}}'

验收与边界

  • 能说明本功能的输入、输出和权限边界。
  • 能用一个最小示例验证配置生效。
  • 真实生产数据和凭据未写入页面、仓库或日志。

官方资料

本页基于 Coze Studio 官方仓库和 Wiki 整理。原项目采用 Apache License 2.0,本站保留许可证、来源和修改说明。

内容授权与来源

本页含基于 coze-dev/coze-studio 官方文档的中文重组、翻译或说明,原资料采用 Apache License 2.0。本站已标记修改,不代表原作者背书。

Apache License 2.0来源和变更说明