Onboarding

2 actions. Each is callable by the agent as a tool, over HTTP via /api/invoke, and (usually) from a UI page.

onboarding.get

GET

Return whether the active workspace still needs the first-run onboarding wizard.

  • AI tool: onboarding_get
  • API: GET /api/invoke/onboarding.get

Input

No parameters.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

onboarding.complete

POST · mutating

Mark first-run onboarding complete for the active workspace.

  • AI tool: onboarding_complete
  • API: POST /api/invoke/onboarding.complete

Input

Field Type Required Description
skippedChannel boolean
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "skippedChannel": {
      "type": "boolean"
    }
  }
}