Skip to content

Search docs

Find pages, headings, and concepts. Press ⌘K or Ctrl+K to toggle.

Onboarding

First-run org setup steps and progressive completion actions.

Onboarding tracks per-user first-run progress inside an org.

Endpoints

MethodPathDescription
GET/api/v1/onboardingCurrent state and completed steps.
PATCH/api/v1/onboardingUpdate profile fields collected during onboarding.
POST/api/v1/onboardingRun an action.

Actions

ActionPurpose
ensure_getting_started_projectProvision the starter project if missing.
apply_dynamic_setupApply LLM-suggested starter configuration.
complete_organization_setupMark org setup done.
complete_stepMark an individual step complete.
skip_stepSkip a step.
resetReset onboarding state (support/debug).