> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api.logicdialog.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.logicdialog.ai/_mcp/server.

# Start here

Use LogicDialog's API to connect your application to a deployed assistant, or manage workspace configuration with a separately authorised platform identity.

The documentation site is **api.logicdialog.ai**. API requests go to **[https://app.logicdialog.ai](https://app.logicdialog.ai)**, not the documentation host.

## Messaging integration

1. In [Project → Channels → API](https://app.logicdialog.ai/channels?tab=api), create an enabled client with allowed channels, a public HTTPS reply webhook and generated credentials. Copy the API token and signing secret before saving: saved secrets cannot be retrieved.
2. Save and [apply the workstream](/api-reference/workstreams-and-publishing/post-api-workspaces-workspace-id-draft-changes-change-id-apply) to **Live**. Saving a Channels configuration alone does not activate it. API messaging currently supports Live only; use a separate test workspace/client for integration testing.
3. [Send a message](/api-reference/messaging-and-history/post-channels-messages) with `channel=api&workspaceId=WORKSPACE&environment=live&integrationId=CLIENT` with the channel API bearer token and a unique message ID.
4. Store the returned `conversationId`. HTTP 202 means accepted, not that a reply has been delivered.
5. Receive a signed [`message.created` webhook](/api-reference/reply-webhooks/message-created) at the configured callback. Its message contains the approved reply. Deliver it to your customer and acknowledge the webhook with 2xx.
6. [Fetch conversation history](/api-reference/messaging-and-history/get-channels-conversations-conversation-id) using the same workspace, environment, client and token to retrieve public history.
7. Include that `conversationId` on later messages, with the same customer and channel, to continue the conversation.

The query `channel=api` selects the transport. The body's `channel`, for example `email`, describes the customer interaction and must be enabled for that client. It does not cause SMTP delivery: your application delivers the reply.

## Use the API explorer

Open an operation in the API reference, select the appropriate authentication method, and enter your token **without** the `Bearer ` prefix. For messaging and client history choose **ChannelApiToken**. Fill in your workspace and client identifiers, then send the request.

Requests are real: posting a message can generate a reply and call your webhook; applying a workstream deploys changes. Use a test workspace for exploration.

Fern's hosted explorer uses its request proxy so browser CORS restrictions do not prevent API testing. Credentials pass through that proxy in transit and remain in your browser session. A signed-in LogicDialog session is not forwarded into hosted documentation. Use **PlatformBearer** with a valid Kinde API access token for management operations; **PlatformSession** only describes same-origin app access and cannot be used by the hosted explorer.

## API sections

* **Messaging and history** and **Reply webhooks**: application integration with channel credentials.
* **Knowledge**, **Configuration**, **Assistants**, and **Workstreams and publishing**: authenticated workspace management and deployment.
* **Conversation review**, **Live Chat and operator events**, **Analytics**, and **Search**: staff review and support tooling.
* **Channels** and **Actions**: integration configuration.
* **Administration**, **AI provider**, **Authentication**, **Provider callbacks**, and **Service and identity**: platform operations and transport setup.

The reference covers supported integration HTTP operations; internal storage and processing endpoints are excluded. Some provider/configuration responses are extensible objects rather than closed schemas. WebSocket transport for the web widget is not a channel-key REST interface; use the contact widget client for that transport.

## Open the app from a guide

Links to Channels, Knowledge, Changes and other app pages open LogicDialog in a new tab. The app uses your most recently selected workspace and remembered workstream; confirm the workspace and workstream in the header before making changes. If you have not selected a workspace before, select one you can access.