COconductorone
Conversations

Ensure Onboarding Session

Changed on

EnsureOnboardingSession returns the tenant's active onboarding conversation, or creates and starts it once. Retries converge on the stored conversation.

post/api/v1/conversations/onboarding:ensure

Request

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

Request body

C1ApiConversationsV1EnsureOnboardingSessionRequest required

Requests the active onboarding conversation for the caller's tenant.

Response

Returns the active onboarding conversation and whether this call created it.

conversationIdstring

The active onboarding conversation ID.

createdboolean

True only when this call created and started the conversation.

Changes