部署环境

​

基础 URL

​

认证

curl https://api.example.com/v2/workflows/run \
  -H "Authorization: Bearer $DIFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"inputs": {}, "response_mode": "blocking", "user": "user-123"}'

​

支持的接口

• Workflow 应用：
  • 执行工作流
  • 停止工作流任务
• Chatflow 应用：
  • 发送对话消息
  • 停止响应
  • 获取会话列表
  • 删除会话
  • 重命名会话
  • 获取会话历史消息
  • 获取会话变量
  • 更新会话变量
• 两类应用通用：
  • 上传文件
  • 下载文件

​

错误

{
  "code": "deployment_not_ready",
  "message": "deployment is in progress",
  "status": 503
}

• 运行类和上传类操作（工作流的执行与停止、对话的发送与停止、文件上传）在密钥无效或部署不可用时，返回以下错误码：

  错误码	状态码	含义
  token_invalid	401	API 密钥缺失、格式错误或无法识别。
  unauthorized	401	API 密钥已撤销。
  forbidden	403	该环境的 API 访问已在 访问点 中关闭。
  deployment_undeployed	503	应用已从此环境下线。部署一个版本即可恢复服务。
  deployment_not_ready	503	部署正在进行中，稍后重试。
  apprunner_not_deployed	503	环境不可用，例如正在删除、未运行或无法连接。请平台管理员检查该环境。
  service_not_ready	503	已部署的版本尚未在该环境中就绪，例如正在加载或正在被替换。稍后重试。
  enterprise_unavailable	503	平台侧的路由服务暂时不可用，稍后重试。

• 会话管理和文件下载返回：
  • 密钥无效时返回 401 unauthorized。
  • 应用关闭了 API 访问，或在此环境中没有可用的部署时，返回 400 app_unavailable。
• 工作流运行或对话请求超过该环境的最长执行时间（默认 20 分钟）时会停止，并返回 request_timeout：阻塞式返回时响应 HTTP 504，流式返回时则在事件流中收到一个 status: 504 的 error 事件。 该时限对应的配置项见 部署环境（App Runner） 中的 enterprise.workflowMaxExecutionTimeSeconds。