# LogicDialog API documentation Instructions for AI Agents: - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.logicdialog.ai/_mcp/server ## Docs - [Start here](https://api.logicdialog.ai/integration-guides/start-here.md) - [Authentication](https://api.logicdialog.ai/integration-guides/authentication.md) - [Send messages and read replies](https://api.logicdialog.ai/integration-guides/send-messages-and-read-replies.md) - [Data collection and topics](https://api.logicdialog.ai/integration-guides/data-collection-and-topics.md) - [CXone agent platform](https://api.logicdialog.ai/integration-guides/c-xone-agent-platform.md) - [Reply webhooks and events](https://api.logicdialog.ai/integration-guides/reply-webhooks-and-events.md) - [Add and publish knowledge](https://api.logicdialog.ai/integration-guides/add-and-publish-knowledge.md) - [Workflows and events](https://api.logicdialog.ai/integration-guides/workflows-and-events.md) - [Alerts and notifications](https://api.logicdialog.ai/integration-guides/alerts-and-notifications.md) ## API Docs - [Approved reply is available](https://api.logicdialog.ai/api-reference/reply-webhooks/message-created.md): API reference > Reply Webhooks - [Health check](https://api.logicdialog.ai/api-reference/service-and-identity/get-health.md): API reference > Service and Identity - [Readiness check with runtime configuration summary](https://api.logicdialog.ai/api-reference/service-and-identity/get-ready.md): API reference > Service and Identity - [Read signed-in identity](https://api.logicdialog.ai/api-reference/service-and-identity/get-api-auth-me.md): API reference > Service and Identity - [Read organisation claims](https://api.logicdialog.ai/api-reference/service-and-identity/get-api-orgs.md): API reference > Service and Identity - [Download the OpenAPI contract](https://api.logicdialog.ai/api-reference/service-and-identity/get-api-docs-openapi-json.md): API reference > Service and Identity - [Read an integration guide](https://api.logicdialog.ai/api-reference/service-and-identity/get-api-docs-guides-guide.md): API reference > Service and Identity - [Download the public OpenAPI contract](https://api.logicdialog.ai/api-reference/service-and-identity/get-openapi-json.md): API reference > Service and Identity - [Start browser login through Kinde/OIDC](https://api.logicdialog.ai/api-reference/authentication/get-auth-login.md): API reference > Authentication - [Complete Kinde/OIDC browser login and create an HTTP-only session cookie](https://api.logicdialog.ai/api-reference/authentication/get-auth-callback.md): API reference > Authentication - [Clear the local LogicDialog browser session](https://api.logicdialog.ai/api-reference/authentication/get-auth-logout.md): API reference > Authentication - [List workspaces visible to the current user](https://api.logicdialog.ai/api-reference/workspaces/get-api-workspaces.md): API reference > Workspaces - [Create a workspace](https://api.logicdialog.ai/api-reference/workspaces/post-api-workspaces.md): API reference > Workspaces - [Delete a workspace](https://api.logicdialog.ai/api-reference/workspaces/delete-api-workspaces-workspace-id.md): API reference > Workspaces - [Read effective workspace permissions](https://api.logicdialog.ai/api-reference/workspaces/get-api-workspaces-workspace-id-access.md): API reference > Workspaces - [List customer-facing test and live environments for a workspace](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/get-api-workspaces-workspace-id-environments.md): API reference > Workstreams and Publishing - [Create a named test environment for safe provider-backed testing](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/post-api-workspaces-workspace-id-environments.md): API reference > Workstreams and Publishing - [List draft changes for a workspace](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/get-api-workspaces-workspace-id-draft-changes.md): API reference > Workstreams and Publishing - [Create a named draft change for safe editing](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/post-api-workspaces-workspace-id-draft-changes.md): API reference > Workstreams and Publishing - [Validate workspace configuration](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/post-api-workspaces-workspace-id-operations-validate.md): API reference > Workstreams and Publishing - [Apply a workstream and deploy to an environment](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/post-api-workspaces-workspace-id-draft-changes-change-id-apply.md): API reference > Workstreams and Publishing - [Delete a workstream](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/delete-api-workspaces-workspace-id-draft-changes-change-id.md): API reference > Workstreams and Publishing - [Update an environment](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/put-api-workspaces-workspace-id-environments-environment-id.md): API reference > Workstreams and Publishing - [Delete a test environment](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/delete-api-workspaces-workspace-id-environments-environment-id.md): API reference > Workstreams and Publishing - [Redeploy an environment](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/post-api-workspaces-workspace-id-environments-environment-id-redeploy.md): API reference > Workstreams and Publishing - [List workspace environment variables](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/get-api-workspaces-workspace-id-environments-environment-id-variables.md): API reference > Workstreams and Publishing - [Replace workspace environment variables](https://api.logicdialog.ai/api-reference/workstreams-and-publishing/put-api-workspaces-workspace-id-environments-environment-id-variables.md): API reference > Workstreams and Publishing - [Legacy audit acknowledgement shell; not channel message processing](https://api.logicdialog.ai/api-reference/provider-callbacks/post-api-webhooks-provider-workspace-id-event-path.md): API reference > Provider Callbacks - [List provider conversations enriched with channel identity and local handover records](https://api.logicdialog.ai/api-reference/conversation-review/get-api-workspaces-workspace-id-conversations.md): API reference > Conversation Review - [Read a conversation transcript and analysis](https://api.logicdialog.ai/api-reference/conversation-review/get-api-workspaces-workspace-id-conversations-conversation-id.md): API reference > Conversation Review - [Delete an inactive conversation and its stored LogicDialog history](https://api.logicdialog.ai/api-reference/conversation-review/delete-api-workspaces-workspace-id-conversations-conversation-id.md): API reference > Conversation Review - [Start or confirm a durable customer-history deletion job](https://api.logicdialog.ai/api-reference/conversation-review/post-api-workspaces-workspace-id-conversations-delete-user-history.md): API reference > Conversation Review - [Download conversation audio](https://api.logicdialog.ai/api-reference/conversation-review/get-api-workspaces-workspace-id-conversations-conversation-id-audio.md): API reference > Conversation Review - [View a knowledge document retrieved during a workspace conversation](https://api.logicdialog.ai/api-reference/conversation-review/get-conversation-knowledge-document.md): API reference > Conversation Review - [Preview and permanently delete conversations in one environment and an inclusive UTC date range.](https://api.logicdialog.ai/api-reference/conversation-review/post-api-workspaces-workspace-id-conversations-delete-environment-history.md): API reference > Conversation Review - [Start a background review of environment conversation history.](https://api.logicdialog.ai/api-reference/conversation-review/post-api-workspaces-workspace-id-conversations-environment-deletions.md): API reference > Conversation Review - [Read deletion review or cleanup progress.](https://api.logicdialog.ai/api-reference/conversation-review/get-api-workspaces-workspace-id-conversations-environment-deletions-job-id.md): API reference > Conversation Review - [Confirm a reviewed deletion or resume a failed operation.](https://api.logicdialog.ai/api-reference/conversation-review/post-api-workspaces-workspace-id-conversations-environment-deletions-job-id-confirm.md): API reference > Conversation Review - [Query indexed conversation summaries](https://api.logicdialog.ai/api-reference/analytics/get-api-workspaces-workspace-id-analytics-conversations.md): API reference > Analytics - [Report indexed conversation performance](https://api.logicdialog.ai/api-reference/analytics/get-api-workspaces-workspace-id-analytics-performance.md): API reference > Analytics - [List configured phone handover numbers](https://api.logicdialog.ai/api-reference/search/get-api-workspaces-workspace-id-query-phone-numbers.md): API reference > Search - [Import AI configuration into a new review draft without deploying](https://api.logicdialog.ai/api-reference/ai-provider/post-api-workspaces-workspace-id-provider-import.md): API reference > AI Provider - [Create a signed preview connection](https://api.logicdialog.ai/api-reference/ai-provider/get-api-workspaces-workspace-id-preview-session.md): API reference > AI Provider - [List available voices, models and costs](https://api.logicdialog.ai/api-reference/ai-provider/get-api-workspaces-workspace-id-provider-catalog.md): API reference > AI Provider - [Create an anonymous widget session for a configured integration and allowed origin.](https://api.logicdialog.ai/api-reference/messaging-and-history/post-channels-sessions.md): API reference > Messaging and History - [Send an application message or receive a channel event](https://api.logicdialog.ai/api-reference/messaging-and-history/post-channels-messages.md): API reference > Messaging and History - [Switch one active relay conversation to agent mode and stop AI replies.](https://api.logicdialog.ai/api-reference/messaging-and-history/post-channels-handover.md): API reference > Messaging and History - [Read customer-visible history for a conversation belonging to this API client. Drafts and internal records are excluded.](https://api.logicdialog.ai/api-reference/messaging-and-history/get-channels-conversations-conversation-id.md): API reference > Messaging and History - [List unresolved handover conversations and waiting count](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/get-api-workspaces-workspace-id-live-chat.md): API reference > Live Chat and Operator Events - [Get the handover transcript and context](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/get-api-workspaces-workspace-id-live-chat-id.md): API reference > Live Chat and Operator Events - [Claim exclusive ownership of a conversation](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/post-api-workspaces-workspace-id-live-chat-id-claim.md): API reference > Live Chat and Operator Events - [Renew the current operator ownership lease](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/post-api-workspaces-workspace-id-live-chat-id-heartbeat.md): API reference > Live Chat and Operator Events - [Return a conversation to the support queue](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/post-api-workspaces-workspace-id-live-chat-id-release.md): API reference > Live Chat and Operator Events - [Send a human reply through its channel adapter](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/post-api-workspaces-workspace-id-live-chat-id-messages.md): API reference > Live Chat and Operator Events - [Mark customer messages as read by the owner](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/post-api-workspaces-workspace-id-live-chat-id-read.md): API reference > Live Chat and Operator Events - [Resolve a human case; native sessions end, durable conversations permit AI on the next incoming message](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/post-api-workspaces-workspace-id-live-chat-id-resolve.md): API reference > Live Chat and Operator Events - [Subscribe to operator changes (SSE)](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/get-api-workspaces-workspace-id-live-chat-events.md): API reference > Live Chat and Operator Events - [Discard a held reply](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/post-api-workspaces-workspace-id-live-chat-id-discard-draft.md): API reference > Live Chat and Operator Events - [Recover a failed delivery](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/post-api-workspaces-workspace-id-live-chat-id-delivery.md): API reference > Live Chat and Operator Events - [Save an operator reply draft](https://api.logicdialog.ai/api-reference/live-chat-and-operator-events/post-api-workspaces-workspace-id-live-chat-id-draft.md): API reference > Live Chat and Operator Events - [Read channel configuration for the selected workstream.](https://api.logicdialog.ai/api-reference/channels/get-api-workspaces-workspace-id-channels.md): API reference > Channels - [Commit one environment’s legacy-compatible channel configuration to a workstream.](https://api.logicdialog.ai/api-reference/channels/put-api-workspaces-workspace-id-channels.md): API reference > Channels - [Test a mailbox connection](https://api.logicdialog.ai/api-reference/channels/post-api-workspaces-workspace-id-channels-test-mailbox.md): API reference > Channels - [List shared action credential references](https://api.logicdialog.ai/api-reference/actions/get-api-workspaces-workspace-id-action-credentials.md): API reference > Actions - [Create a shared action credential](https://api.logicdialog.ai/api-reference/actions/post-api-workspaces-workspace-id-action-credentials.md): API reference > Actions - [List recent action test results](https://api.logicdialog.ai/api-reference/actions/get-api-workspaces-workspace-id-actions-runs.md): API reference > Actions - [Test an action](https://api.logicdialog.ai/api-reference/actions/post-api-workspaces-workspace-id-actions-test.md): API reference > Actions - [Update a workspace-owned action credential](https://api.logicdialog.ai/api-reference/actions/patch-api-workspaces-workspace-id-action-credentials-credential-id.md): API reference > Actions - [Read platform administration permissions](https://api.logicdialog.ai/api-reference/administration/get-api-admin-access.md): API reference > Administration - [List administered workspaces](https://api.logicdialog.ai/api-reference/administration/get-api-admin-workspaces.md): API reference > Administration - [Inspect local and remote branch differences](https://api.logicdialog.ai/api-reference/administration/get-api-admin-repository-sync.md): API reference > Administration - [Synchronise repository branches](https://api.logicdialog.ai/api-reference/administration/post-api-admin-repository-sync-action.md): API reference > Administration - [List users and available permissions](https://api.logicdialog.ai/api-reference/administration/get-api-admin-users.md): API reference > Administration - [Read organisation user permissions](https://api.logicdialog.ai/api-reference/administration/get-api-admin-users-user-id-access.md): API reference > Administration - [Update organisation user permissions](https://api.logicdialog.ai/api-reference/administration/put-api-admin-users-user-id-access.md): API reference > Administration - [Create an assistant](https://api.logicdialog.ai/api-reference/assistants/post-api-workspaces-workspace-id-agents.md): API reference > Assistants - [Update an assistant](https://api.logicdialog.ai/api-reference/assistants/put-api-workspaces-workspace-id-agents-agent-key.md): API reference > Assistants - [Delete an assistant](https://api.logicdialog.ai/api-reference/assistants/delete-api-workspaces-workspace-id-agents-agent-key.md): API reference > Assistants - [Save visual routing](https://api.logicdialog.ai/api-reference/configuration/put-api-workspaces-workspace-id-routing.md): API reference > Configuration - [Save workspace settings](https://api.logicdialog.ai/api-reference/configuration/put-api-workspaces-workspace-id-settings.md): API reference > Configuration - [List knowledge sources](https://api.logicdialog.ai/api-reference/knowledge/get-api-workspaces-workspace-id-knowledge-sources.md): API reference > Knowledge - [Add a knowledge source to a workstream](https://api.logicdialog.ai/api-reference/knowledge/post-api-workspaces-workspace-id-knowledge-sources.md): API reference > Knowledge - [Update a connected knowledge source](https://api.logicdialog.ai/api-reference/knowledge/put-knowledge-source.md): API reference > Knowledge - [Remove a knowledge source](https://api.logicdialog.ai/api-reference/knowledge/delete-knowledge-source.md): API reference > Knowledge - [Import the latest source content](https://api.logicdialog.ai/api-reference/knowledge/post-knowledge-source-refresh.md): API reference > Knowledge - [Migrate and link knowledge through a LogicDialog source](https://api.logicdialog.ai/api-reference/knowledge/post-knowledge-source-migrate.md): API reference > Knowledge - [Read source webhook and processing status](https://api.logicdialog.ai/api-reference/knowledge/get-knowledge-source-status.md): API reference > Knowledge - [Retry failed source imports](https://api.logicdialog.ai/api-reference/knowledge/post-knowledge-source-retry.md): API reference > Knowledge - [Replace a source webhook token](https://api.logicdialog.ai/api-reference/knowledge/post-knowledge-source-rotate-token.md): API reference > Knowledge - [Receive a knowledge change](https://api.logicdialog.ai/api-reference/knowledge/post-knowledge-hook.md): API reference > Knowledge - [Upsert a Knowledge API document](https://api.logicdialog.ai/api-reference/knowledge/put-knowledge-api-document.md): API reference > Knowledge - [Receive a knowledge deletion](https://api.logicdialog.ai/api-reference/knowledge/delete-knowledge-hook.md): API reference > Knowledge - [Upsert a Knowledge API document by ID](https://api.logicdialog.ai/api-reference/knowledge/post-knowledge-api-document-by-id.md): API reference > Knowledge - [Delete a Knowledge API document by ID](https://api.logicdialog.ai/api-reference/knowledge/delete-knowledge-api-document-by-id.md): API reference > Knowledge - [Add a document to a collection](https://api.logicdialog.ai/api-reference/knowledge/post-knowledge-collection-document.md): API reference > Knowledge - [Edit a manual collection document](https://api.logicdialog.ai/api-reference/knowledge/put-knowledge-collection-document.md): API reference > Knowledge - [Remove a collection document](https://api.logicdialog.ai/api-reference/knowledge/delete-knowledge-collection-document.md): API reference > Knowledge - [Read knowledge indexing status](https://api.logicdialog.ai/api-reference/knowledge/get-knowledge-indexing.md): API reference > Knowledge - [Start missing knowledge indexes](https://api.logicdialog.ai/api-reference/knowledge/post-knowledge-source-indexing.md): API reference > Knowledge - [GET workflows /hooks/{route}](https://api.logicdialog.ai/api-reference/workflows/callback-workflow-get-hooksroute.md): API reference > Workflows - [POST workflows /hooks/{route}](https://api.logicdialog.ai/api-reference/workflows/callback-workflow-post-hooksroute.md): API reference > Workflows - [PUT workflows /hooks/{route}](https://api.logicdialog.ai/api-reference/workflows/callback-workflow-put-hooksroute.md): API reference > Workflows - [DELETE workflows /hooks/{route}](https://api.logicdialog.ai/api-reference/workflows/callback-workflow-delete-hooksroute.md): API reference > Workflows - [PATCH workflows /hooks/{route}](https://api.logicdialog.ai/api-reference/workflows/callback-workflow-patch-hooksroute.md): API reference > Workflows - [Schedule a call or SMS, or attempt an immediate callback](https://api.logicdialog.ai/api-reference/outbound/schedule-api-outbound-contact.md): API reference > Outbound - [Read the status of a contact submitted by this API client](https://api.logicdialog.ai/api-reference/outbound/get-api-outbound-contact.md): API reference > Outbound ## OpenAPI Specification - [OpenAPI JSON](https://api.logicdialog.ai/openapi.json): raw OpenAPI 3.1 specification for this API, JSON format - [OpenAPI YAML](https://api.logicdialog.ai/openapi.yaml): raw OpenAPI 3.1 specification for this API, YAML format