Skip to main content
POST
Generate guidance for an onboarding checklist step.

Authorizations

Authorization
string
header
required

Supabase JWT token in Authorization: Bearer header

Body

application/json
checklist_item_id
string
required

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

user_role
string
required

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

facts
object

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

completed_steps
string[]

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

user_goal
string

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

org_id
string

Optional organization ID for multi-tenant context.

user_id
string

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

Response

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

narration
string
required

The LLM-generated guidance narration for this step.

session_id
string
required

Correlation ID for this guidance session (for telemetry).

fallback
boolean
required

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

action
object

The suggested bounded action the user should take.

next_step
object

Metadata about the current step and estimated time.

error
string

Optional error message (only if fallback: true).