> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kaireonai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Onboarding Progress

> Track and update user onboarding checklist progress.

The Onboarding API tracks each user's progress through the platform's getting-started checklist. It powers the onboarding widget shown to new users.

## GET /api/v1/onboarding/progress

Get the current user's onboarding progress.

### Response

```json theme={null}
{
  "progress": {
    "load_data": true,
    "explore_flow": true,
    "run_recommendation": false,
    "view_trace": false,
    "try_assistant": false
  },
  "dismissed": false,
  "completedCount": 2,
  "totalSteps": 5,
  "allComplete": false
}
```

### Onboarding Steps

| Step                 | Description                            |
| -------------------- | -------------------------------------- |
| `load_data`          | Load sample data or create a connector |
| `explore_flow`       | Open and explore a decision flow       |
| `run_recommendation` | Execute a Recommend API call           |
| `view_trace`         | View a decision trace                  |
| `try_assistant`      | Use the AI assistant                   |

***

## POST /api/v1/onboarding/progress

Mark a step as complete or dismiss the onboarding checklist.

### Mark Step Complete

```json theme={null}
{
  "step": "run_recommendation"
}
```

**Response:**

```json theme={null}
{
  "progress": {
    "load_data": true,
    "explore_flow": true,
    "run_recommendation": true,
    "view_trace": false,
    "try_assistant": false
  }
}
```

### Dismiss Checklist

```json theme={null}
{
  "dismiss": true
}
```

**Response:**

```json theme={null}
{ "dismissed": true }
```