API 参考 / onboarding

Step 2 邀请成员(可暂不邀请)

POST /api/v1/onboarding/invitations · confirmOnboardingInvitations

发送至少一个邀请,或显式选择暂不邀请。

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

请求体

skip(必填)
boolean
invitations
CreateInvitationRequest[]
invitations[].email(必填)
string
invitations[].roleId(必填)
string

响应字段 · 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

请求示例(curl)

curl -X POST "https://你的项目.workflow.games/api/v1/onboarding/invitations" \
  -H "Authorization: Bearer wfp_…" \
  -H "content-type: application/json" \
  --data '{"skip":true,"invitations":[{"email":"[email protected]","roleId":"018f3c2e-0000-7000-8000-000000000000"}]}'

响应示例

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 参考索引

Workflow 正在加载…