API 参考 / requirements

创建需求

POST /api/v1/requirements · createRequirement

创建当前项目需求；actor 与 project 只来自 session/Host 上下文。

鉴权：项目 API Token（Authorization: Bearer wfp_…）。详见 Agent 接入。

参数

Idempotency-Key: string —— 幂等键（建议用 UUID，最长 255 字符）。重复提交同键且请求体一致时返回首次创建的结果（200）而不新建对象；请求体不一致返回 409。有效期 24 小时。

请求体

title（必填）: string
description: string
priority: enum；取值：P0 / P1 / P2 / P3
risk: enum；取值：high / medium / low
ownerId: string
module: string
category: string
releaseWindowId: string
roomId: string
startOn: string
targetOn: string
estimateDays: integer
reason: string

响应字段 · 201

id（必填）: string
displayKey（必填）: string
title（必填）: string
description: string
roomId（必填）: string
status（必填）: string
priority（必填）: enum；取值：P0 / P1 / P2 / P3
risk（必填）: enum；取值：high / medium / low
ownerId（必填）: string
creatorId（必填）: string
module（必填）: string
category（必填）: string
releaseWindowId（必填）: string
startOn（必填）: string
targetOn（必填）: string
progress（必填）: integer
estimateDays（必填）: integer
stateEnteredAt（必填）: string
createdAt（必填）: string
updatedAt（必填）: string

响应字段 · 200

id（必填）: string
displayKey（必填）: string
title（必填）: string
description: string
roomId（必填）: string
status（必填）: string
priority（必填）: enum；取值：P0 / P1 / P2 / P3
risk（必填）: enum；取值：high / medium / low
ownerId（必填）: string
creatorId（必填）: string
module（必填）: string
category（必填）: string
releaseWindowId（必填）: string
startOn（必填）: string
targetOn（必填）: string
progress（必填）: integer
estimateDays（必填）: integer
stateEnteredAt（必填）: string
createdAt（必填）: string
updatedAt（必填）: string

错误

401：Problem 错误响应
403：Problem 错误响应
409：Problem 错误响应
422：Problem 错误响应

请求示例（curl）

curl -X POST "https://你的项目.workflow.games/api/v1/requirements" \
  -H "Authorization: Bearer wfp_…" \
  -H "content-type: application/json" \
  --data '{"title":"示例标题","description":"一段描述文字","priority":"P0"}'

响应示例

HTTP/1.1 201
{
  "id": "018f3c2e-0000-7000-8000-000000000000",
  "displayKey": "示例文本",
  "title": "示例标题",
  "roomId": "018f3c2e-0000-7000-8000-000000000000",
  "status": "示例文本",
  "priority": "P0",
  "risk": "high",
  "ownerId": "018f3c2e-0000-7000-8000-000000000000",
  "creatorId": "018f3c2e-0000-7000-8000-000000000000",
  "module": "示例文本",
  "category": "示例文本",
  "releaseWindowId": "018f3c2e-0000-7000-8000-000000000000",
  "startOn": "2026-08-01",
  "targetOn": "2026-08-01",
  "progress": 1,
  "estimateDays": 1,
  "stateEnteredAt": "示例文本",
  "createdAt": "示例文本",
  "updatedAt": "2026-08-01"
}

合同真值：OpenAPI 3.1（0.1.0）。

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