Wizard State Manager

List active wizard sessions for the authenticated user

{
  "data": [
    {
      "session_id": "sess-7f3a92b1",
      "wizard_id": "onboarding-wizard-v3",
      "user_id": "usr-00124",
      "current_step_index": 2,
      "total_steps": 6,
      "status": "in_progress",
      "started_at": "2026-03-26T08:30:00Z",
      "last_activity_at": "2026-03-26T08:42:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1
  }
}

Get a specific wizard session with current answers

{
  "session_id": "sess-7f3a92b1",
  "wizard_id": "onboarding-wizard-v3",
  "user_id": "usr-00124",
  "current_step_index": 2,
  "total_steps": 6,
  "status": "in_progress",
  "answers": {
    "screen-01": {
      "chosen": [
        "opt-b"
      ]
    },
    "screen-02": {
      "chosen": [
        "opt-a",
        "opt-c"
      ]
    }
  },
  "started_at": "2026-03-26T08:30:00Z",
  "last_activity_at": "2026-03-26T08:42:00Z"
}

Start a new wizard session

{
  "wizard_id": "onboarding-wizard-v3",
  "user_id": "usr-00124",
  "locale": "en-IE"
}

{
  "session_id": "sess-9c1d45e2",
  "wizard_id": "onboarding-wizard-v3",
  "user_id": "usr-00124",
  "current_step_index": 0,
  "total_steps": 6,
  "status": "in_progress",
  "started_at": "2026-03-26T10:30:00Z"
}

Update session state (advance, go back, or save answers)

{
  "action": "next_step",
  "answers": {
    "screen-02": {
      "chosen": [
        "opt-a"
      ]
    }
  }
}

{
  "session_id": "sess-7f3a92b1",
  "current_step_index": 3,
  "status": "in_progress",
  "answers": {
    "screen-01": {
      "chosen": [
        "opt-b"
      ]
    },
    "screen-02": {
      "chosen": [
        "opt-a"
      ]
    }
  },
  "updated_at": "2026-03-26T10:35:00Z"
}

Terminate and discard a wizard session

{
  "deleted": true,
  "session_id": "sess-7f3a92b1"
}

Advance the session to the next wizard step

{
  "answers": {
    "screen-03": {
      "chosen": [
        "opt-c"
      ]
    }
  }
}

{
  "session_id": "sess-7f3a92b1",
  "previous_step_index": 2,
  "current_step_index": 3,
  "status": "in_progress"
}

Navigate the session back one step

{
  "session_id": "sess-7f3a92b1",
  "previous_step_index": 3,
  "current_step_index": 2,
  "status": "in_progress"
}

Persist current session state as a resumable draft

{
  "answers": {
    "screen-01": {
      "chosen": [
        "opt-b"
      ]
    },
    "screen-02": {
      "chosen": [
        "opt-a"
      ]
    }
  }
}

{
  "draft_id": "draft-44ab12f0",
  "session_id": "sess-7f3a92b1",
  "step_index": 2,
  "saved_at": "2026-03-26T10:40:00Z"
}

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}