API 参考 / workflow-config

获取(或初始化)草稿

GET /api/v1/projects/{projectId}/workflows/{templateId}/draft · getWorkflowDraft

GetOrCreate 语义:若草稿已存在直接返回;否则从当前已发布版本派生一个新草稿(version_no = max+1)。需 manage_workflows(派生草稿为写操作,与编辑器权限一致)。

鉴权:项目 API Token(Authorization: Bearer wfp_…)。详见 Agent 接入。

参数

projectId(必填)
string
templateId(必填)
string

响应字段 · 200

version(必填)
WorkflowVersion
version.id(必填)
string
version.projectId(必填)
string
version.templateId(必填)
string
version.versionNo(必填)
integer
version.status(必填)
enum;取值:draft / published / archived
version.changeNote
string
version.publishedAt
string
version.publishedBy
string
version.createdAt(必填)
string
version.updatedAt(必填)
string
states(必填)
WorkflowState[]
states[].key(必填)
string
states[].name(必填)
string
states[].semantic(必填)
string
states[].color
string
states[].position
integer
states[].isInitial(必填)
boolean
states[].isTerminal(必填)
boolean
states[].layout
object
slots(必填)
WorkflowSlot[]
slots[].key(必填)
string
slots[].name(必填)
string
slots[].origin(必填)
string
slots[].cardinality(必填)
enum;取值:single / multi
slots[].multiResolution
string
slots[].isOwnerSlot(必填)
boolean
slots[].sortOrder
integer
transitions(必填)
WorkflowTransition[]
transitions[].id
string
transitions[].name
string
transitions[].fromKey
string
transitions[].toKey(必填)
string
transitions[].global(必填)
boolean
transitions[].requireReason
boolean
transitions[].sortOrder
integer
transitions[].guards
WorkflowGuard[]
transitions[].guards[].phase(必填)
string
transitions[].guards[].type(必填)
string
transitions[].guards[].config
object
transitions[].guards[].errorMessage
string
transitions[].guards[].sortOrder(必填)
integer
transitions[].guards[].enabled(必填)
boolean
transitions[].actions
WorkflowAction[]
transitions[].actions[].kind(必填)
enum;取值:set_field
transitions[].actions[].fieldKey
string —— set_field 目标字段键(如 progress / resolution)。
transitions[].actions[].value
string —— 要写入目标字段的值(字符串承载,set_field 应用时按字段类型解释)。
transitions[].route
WorkflowRoute
transitions[].route.targetSlotKey(必填)
string
transitions[].route.emptyFallback
string
transitions[].route.notifyPolicy
string

错误

请求示例(curl)

curl -X GET "https://你的项目.workflow.games/api/v1/projects/{projectId}/workflows/{templateId}/draft" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "version": {
    "id": "018f3c2e-0000-7000-8000-000000000000",
    "projectId": "018f3c2e-0000-7000-8000-000000000000",
    "templateId": "018f3c2e-0000-7000-8000-000000000000",
    "versionNo": 1,
    "status": "draft",
    "createdAt": "示例文本",
    "updatedAt": "2026-08-01"
  },
  "states": [
    {
      "key": "示例文本",
      "name": "示例标题",
      "semantic": "示例文本",
      "isInitial": true,
      "isTerminal": true
    }
  ],
  "slots": [
    {
      "key": "示例文本",
      "name": "示例标题",
      "origin": "示例文本",
      "cardinality": "single",
      "isOwnerSlot": true
    }
  ],
  "transitions": [
    {
      "toKey": "示例文本",
      "global": true,
      "id": "018f3c2e-0000-7000-8000-000000000000"
    }
  ]
}

合同真值:OpenAPI 3.1(0.1.0)。

相关:Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…