Conversation

Subscribe to a conversation's live monitor channel

Subscribe to a conversation to receive a live, curated feed of its lifecycle events as it runs - message, operation (tool call), completion and error events - regardless of how the conversation is being executed (interactive, dispatched, or via an integration such as Slack, Discord or WhatsApp). High-frequency token events are not included.

This returns a streaming response that stays open until the client closes it. You can only subscribe to conversations that belong to your account.

post/conversation/{conversationId}/channel/subscribe

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/conversation/{conversationId}/channel/subscribe
  • Auth: HTTP bearer

Parameters

#/components/parameters/ConversationId (unresolved $ref)

Request body

historyLengthinteger

Number of recent monitor events to replay before following live, so a console opening mid-conversation can catch up.

Response

Successfully subscribed to the conversation monitor channel

Changes

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