Skip to main content
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

{
  "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

StepDescription
load_dataLoad sample data or create a connector
explore_flowOpen and explore a decision flow
run_recommendationExecute a Recommend API call
view_traceView a decision trace
try_assistantUse the AI assistant

​
POST /api/v1/onboarding/progress

Mark a step as complete or dismiss the onboarding checklist.

​
Mark Step Complete

{
  "step": "run_recommendation"
}
Response: 
{
  "progress": {
    "load_data": true,
    "explore_flow": true,
    "run_recommendation": true,
    "view_trace": false,
    "try_assistant": false
  }
}

​
Dismiss Checklist

{
  "dismiss": true
}
Response: 
{ "dismissed": true }