/api/v3/sunburst/onboarding/{step_key}

Start or resume a Sunburst chat session scoped to one Sunburst-guided team onboarding
step. Admin access only. Starts a session that can see only that step's onboarding
tool(s), and records the session on the team's onboarding progress (sunburst_session_id,
status in_progress, started_ts set the first time this step is started).

If the step already has a sunburst_session_id and start_fresh is not true, this resumes
that session (loads the prior response chain and continues it) instead of restarting from
the canned prompt. Otherwise (first time starting the step, or start_fresh=true) it loads
the step's canned prompt and starts a brand-new session, overwriting any prior
sunburst_session_id. Returns a session_id and the initial thread, identical to
POST /api/v3/sunburst/chat.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Onboarding step identifier

Body Params
boolean
Defaults to false

If true, always start a new session from the step's canned prompt, overwriting any existing sunburst_session_id, instead of resuming it.

Responses

400

Unknown step_key

401

Requires admin access

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json