API 参考 / onboarding

初始化引导状态（Host 解析项目）

GET /api/v1/onboarding/state · getOnboardingState

返回四步引导的进度与完成条件状态。不可跳过。 可见性边界（B-00199）：调用者不属于该项目所在组织时返回 404——不是 403， 403 等于确认「这个子域上确实有个项目」，本身就是跨租户信息泄漏。

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

响应字段 · 200

projectId（必填）

string

completed（必填）

boolean

completedAt

string

canManage（必填）

boolean —— 当前用户是否具备项目管理能力；初始化期具备者进入引导，否则只能看到正在初始化提示（文档 §7.3）

steps（必填）

OnboardingStep[]

steps[].key（必填）

enum；取值：roles / invitations / acceptance / complete

steps[].label（必填）

string

steps[].status（必填）

enum；取值：pending / done

错误

• 403：Problem 错误响应
• 404：Problem 错误响应

请求示例（curl）

curl -X GET "https://你的项目.workflow.games/api/v1/onboarding/state" \
  -H "Authorization: Bearer wfp_…"

响应示例

HTTP/1.1 200
{
  "projectId": "018f3c2e-0000-7000-8000-000000000000",
  "completed": true,
  "canManage": true,
  "steps": [
    {
      "key": "roles",
      "label": "示例文本",
      "status": "pending"
    }
  ]
}

合同真值：OpenAPI 3.1（0.1.0）。

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