Onboarding

Generate guidance for an onboarding checklist step.

MNE-5508: Accepts a checklist item ID and user context; generates LLM-driven guidance narration and a bounded action suggestion. Gated behind ONBOARDING_GUIDE_ENABLED (dark by default) and ONBOARDING_GUIDE_ALLOWLIST (defaults to @mnemom.ai). Requires authentication.

post/onboarding/guide

Request

  • Base URL: https://api.mnemom.ai/v1
  • URL: https://api.mnemom.ai/v1/onboarding/guide
  • Auth: HTTP bearer

Request body

checklist_item_idstring required

The ID of the onboarding checklist item (e.g., 'org.create', 'agent.alignment-card').

user_rolestring required

The user's role (e.g., 'organization_owner', 'developer', 'security_lead', 'compliance_officer').

factsobject

Optional contextual facts about the user's state (e.g., org_exists: true, first_agent_chosen: false).

completed_stepsstring[]

Optional array of checklist item IDs the user has already completed.

user_goalstring

Optional user-provided goal or context (e.g., 'Build a support bot', 'Set up trusted governance').

org_idstring

Optional organization ID for multi-tenant context.

user_idstring

Optional user ID (can be overridden from auth context).

Response

Guidance generated successfully. Returns narration, suggested action, next step, and session correlation ID.

narrationstring required

The LLM-generated guidance narration for this step.

session_idstring required

Correlation ID for this guidance session (for telemetry).

fallbackboolean required

True if the response is a fallback (LLM service unavailable or validation error).

errorstring

Optional error message (only if fallback: true).

Changes

No recorded changes to this operation across all 1 revision of this API.