COconductorone
Onboarding Settings

Get

Changed on

Get retrieves the current onboarding progress for the tenant.

get/api/v1/settings/onboarding

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/settings/onboarding
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Response

Successful response

conversationIdstring

The identifier of the onboarding conversation thread, if one is in progress.

intentsstring[] nullable

The intents field.

mcpOnboardingGoalstring

The admin's free-form AIAM onboarding goal, captured at the Goals step.

mcpOnboardingStatus'MCP_ONBOARDING_STATUS_UNSPECIFIED' | 'MCP_ONBOARDING_STATUS_NOT_STARTED' | 'MCP_ONBOARDING_STATUS_IN_PROGRESS' | 'MCP_ONBOARDING_STATUS_COMPLETE' | 'MCP_ONBOARDING_STATUS_DISMISSED'

The current status of the AIAM MCP onboarding briefing, tracked independently of status.

status'ONBOARDING_STATUS_UNSPECIFIED' | 'ONBOARDING_STATUS_NOT_STARTED' | 'ONBOARDING_STATUS_IN_PROGRESS' | 'ONBOARDING_STATUS_COMPLETE' | 'ONBOARDING_STATUS_DISMISSED'

The current status of the tenant onboarding process.

Changes

  • f2cf3228f366Revision changes
    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • fa2bb307d6faRevision changes
    • info

      endpoint added