Skip to content

TINYDOC-3686: Document the live TinyMCE AI service features and update the on-premises pages. #4411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kemister85 wants to merge 1 commit into
base: tinymce/8
Choose a base branch
from
Draft

TINYDOC-3686: Document the live TinyMCE AI service features and update the on-premises pages. #4411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions modules/ROOT/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,8 @@
****** xref:tinymceai-api-overview.adoc[API overview]
****** xref:tinymceai-api-quick-start.adoc[API quick start]
****** xref:tinymceai-streaming.adoc[Streaming]
****** xref:tinymceai-document-processing.adoc[Document Processing]
****** xref:tinymceai-usage.adoc[Usage API]
**** xref:tinymceai-jwt-authentication-intro.adoc[JWT authentication]
***** xref:tinymceai-permissions.adoc[Permissions]
***** Guides
Expand All @@ -289,6 +291,9 @@
***** xref:tinymceai-on-premises-frameworks.adoc[TinyMCE integration]
***** xref:tinymceai-on-premises-production.adoc[Production deployment]
***** xref:tinymceai-on-premises-mcp.adoc[MCP and web integrations (optional)]
***** xref:tinymceai-on-premises-guardrails.adoc[Guardrails]
***** xref:tinymceai-on-premises-hooks.adoc[Hooks]
***** xref:tinymceai-on-premises-moderation.adoc[Content moderation]
***** xref:tinymceai-on-premises-troubleshooting.adoc[Troubleshooting]
***** xref:tinymceai-on-premises-reference.adoc[Reference]
**** xref:ai.adoc[AI Assistant (legacy)]
Expand Down
12 changes: 6 additions & 6 deletions modules/ROOT/pages/tinymceai-actions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ a|
* The `+ai-quickactions-custom+` identifier (labeled **Other**) lists the custom actions set in xref:tinymceai.adoc#tinymceai_quickactions_custom[`+tinymceai_quickactions_custom+`]. See xref:tinymceai-actions.adoc#custom-actions[Custom Actions].
====

For system action endpoints, schemas, and streaming details, see the https://tinymceai.api.tiny.cloud/docs#tag/Actions[Actions API] reference.
For system action endpoints, schemas, and streaming details, see the https://tinymceai.api.tiny.cloud/v1/docs#tag/Actions[Actions API] reference.

[[custom-actions]]
== Custom Actions
Expand Down Expand Up @@ -261,28 +261,28 @@ Actions use streaming output with Server-Sent Events for real-time feedback as r

Built-in Quick Actions—including identifiers, descriptions, and whether each command uses the system Actions API or Chat (Conversations API)—are summarized in xref:tinymceai-actions.adoc#quick-actions-reference-table[Default Actions].

To run a system action, use https://tinymceai.api.tiny.cloud/docs#tag/Actions/operation/callSystemAction[Call a system action] with an `+actionName+` from the rows that have a checkmark in the **API** column of the table above. System actions use built-in prompts, so the request needs no prompt or model. For the token scopes that each system action needs, see xref:tinymceai-permissions.adoc#actions-permissions[Actions permissions].
To run a system action, use https://tinymceai.api.tiny.cloud/v1/docs#tag/Actions/operation/callSystemAction[Call a system action] with an `+actionName+` from the rows that have a checkmark in the **API** column of the table above. System actions use built-in prompts, so the request needs no prompt or model. For the token scopes that each system action needs, see xref:tinymceai-permissions.adoc#actions-permissions[Actions permissions].

For endpoint details, request and response schemas, authentication, and streaming behavior for system `actionName` calls, see https://tinymceai.api.tiny.cloud/docs#tag/Actions[Actions API].
For endpoint details, request and response schemas, authentication, and streaming behavior for system `actionName` calls, see https://tinymceai.api.tiny.cloud/v1/docs#tag/Actions[Actions API].

[[actions-custom-actions-api]]
=== Custom Actions through the API

In addition to system actions, custom actions can be created for specific use cases through the API. Custom actions allow specialized content transformations using custom prompts to control AI behavior.

Unlike system actions that use default identifiers, custom actions use a unified endpoint, https://tinymceai.api.tiny.cloud/docs#tag/Actions/operation/callCustomAction[Call a custom action], where the transformation behavior is defined through a prompt parameter. See https://tinymceai.api.tiny.cloud/docs#tag/Actions[Actions API] for the custom actions endpoint and implementation details.
Unlike system actions that use default identifiers, custom actions use a unified endpoint, https://tinymceai.api.tiny.cloud/v1/docs#tag/Actions/operation/callCustomAction[Call a custom action], where the transformation behavior is defined through a prompt parameter. See https://tinymceai.api.tiny.cloud/v1/docs#tag/Actions[Actions API] for the custom actions endpoint and implementation details.

Custom actions require the `ai:actions:custom` permission in the JWT token. See xref:tinymceai-permissions.adoc#actions-permissions[Actions permissions].

[[actions-streaming]]
=== Streaming Responses

Actions use Server-Sent Events (SSE) for real-time streaming results. See the xref:tinymceai-streaming.adoc[Streaming Responses guide] for detailed implementation information. For the events and their payloads, see https://tinymceai.api.tiny.cloud/docs#tag/Actions/operation/callSystemAction[Call a system action] and https://tinymceai.api.tiny.cloud/docs#tag/Actions/operation/callCustomAction[Call a custom action] in the API reference.
Actions use Server-Sent Events (SSE) for real-time streaming results. See the xref:tinymceai-streaming.adoc[Streaming Responses guide] for detailed implementation information. For the events and their payloads, see https://tinymceai.api.tiny.cloud/v1/docs#tag/Actions/operation/callSystemAction[Call a system action] and https://tinymceai.api.tiny.cloud/v1/docs#tag/Actions/operation/callCustomAction[Call a custom action] in the API reference.

[[actions-api-reference]]
=== API Reference

The https://tinymceai.api.tiny.cloud/docs#tag/Actions[Actions API] reference (interactive OpenAPI documentation) is the full source for system and custom action endpoints, request and response schemas, authentication, worked examples, and streaming action responses.
The https://tinymceai.api.tiny.cloud/v1/docs#tag/Actions[Actions API] reference (interactive OpenAPI documentation) is the full source for system and custom action endpoints, request and response schemas, authentication, worked examples, and streaming action responses.

[[related-features]]
== Related Features
Expand Down
10 changes: 6 additions & 4 deletions modules/ROOT/pages/tinymceai-api-overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The TinyMCE AI REST API enables AI integration within your application using the

[NOTE]
====
**API Reference**: The complete API documentation with all endpoints, parameters, request/response schemas, and interactive examples is available at link:https://tinymceai.api.tiny.cloud/docs[TinyMCE AI API Documentation]
**API Reference**: The complete API documentation with all endpoints, parameters, request/response schemas, and interactive examples is available at link:https://tinymceai.api.tiny.cloud/v1/docs[TinyMCE AI API Documentation]
====

[[getting-started]]
Expand All @@ -24,6 +24,8 @@ New to {pluginname}? Start with the xref:tinymceai-api-quick-start.adoc[Quick St
* xref:tinymceai-chat.adoc[**Chat**]: Interactive AI chats with history and persistent context.
* xref:tinymceai-review.adoc[**Review**]: Content analysis and proofreading, optimized for larger content.
* xref:tinymceai-actions.adoc[**Quick Actions**]: Fast, stateless operations for specific tasks.
* xref:tinymceai-document-processing.adoc[**Document Processing**]: One prompt applied to one or more HTML documents, with the full edited documents or only the changed elements returned.
* xref:tinymceai-usage.adoc[**Usage**]: The credits consumed by the environment and by each requested user over a period, for back-end reporting.

[[architecture]]
== Architecture
Expand All @@ -43,7 +45,7 @@ The version of each endpoint is part of its path, for example `+/v1/conversation
[[pagination]]
== Pagination

List endpoints use cursor pagination. These include the conversation list, and the documents, files, and web resources of a conversation. The API reference documents the pagination parameters on each list operation, for example https://tinymceai.api.tiny.cloud/docs#tag/Conversations/operation/getConversations[Fetch multiple conversations].
List endpoints use cursor pagination. These include the conversation list, and the documents, files, and web resources of a conversation. The API reference documents the pagination parameters on each list operation, for example https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversations/operation/getConversations[Fetch multiple conversations].

[[error-responses]]
== Error responses
Expand Down Expand Up @@ -94,7 +96,7 @@ For example, a token without the permission a request needs returns:
[[error-codes]]
=== Error codes

The API reference lists every code in its https://tinymceai.api.tiny.cloud/docs#section/Overview/Error-codes[Error codes] section. For token errors, see xref:tinymceai-jwt-authentication-intro.adoc#troubleshooting[JWT troubleshooting]. For a `+missing-permissions+` response, see xref:tinymceai-permissions.adoc[Permissions].
The API reference lists every code in its https://tinymceai.api.tiny.cloud/v1/docs#section/Overview/Error-codes[Error codes] section. For token errors, see xref:tinymceai-jwt-authentication-intro.adoc#troubleshooting[JWT troubleshooting]. For a `+missing-permissions+` response, see xref:tinymceai-permissions.adoc[Permissions].

[[rate-limit-errors]]
=== Rate limit errors
Expand All @@ -104,5 +106,5 @@ For `+429+` responses with the code `+rate-limits-exceeded+`, see xref:tinymceai
[[resources-and-support]]
== Resources and support

* **API Documentation**: link:https://tinymceai.api.tiny.cloud/docs[Complete API reference for TinyMCE AI].
* **API Documentation**: link:https://tinymceai.api.tiny.cloud/v1/docs[Complete API reference for TinyMCE AI].
* **Customer Support**: link:https://www.tiny.cloud/contact/[Contact us] to get help from the support team or speak with sales.
2 changes: 1 addition & 1 deletion modules/ROOT/pages/tinymceai-api-quick-start.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ For feature documentation and API access information, see:
* xref:tinymceai-actions.adoc#actions-api[Quick Actions]: Content transformation through the Actions API.
* xref:tinymceai-streaming.adoc[Streaming]: Real-time AI interactions with code examples.

link:https://tinymceai.api.tiny.cloud/docs[Complete API Documentation]: Full API reference with interactive examples for all endpoints.
link:https://tinymceai.api.tiny.cloud/v1/docs[Complete API Documentation]: Full API reference with interactive examples for all endpoints.

[[next-steps]]
== Next steps
Expand Down
26 changes: 13 additions & 13 deletions modules/ROOT/pages/tinymceai-chat.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

The {pluginname} Chat is a conversational AI feature that facilitates rich, multi-turn interactions between users and an AI Assistant. It provides context setting, model selection, chat history, and capabilities for web search and reasoning.

The Chat feature is available as part of the `+tinymceai+` plugin for {productname} and through the https://tinymceai.api.tiny.cloud/docs#tag/Conversations[Conversations API]. This page covers both:
The Chat feature is available as part of the `+tinymceai+` plugin for {productname} and through the https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversations[Conversations API]. This page covers both:

* Plugin sections describe built-in user-facing features and configuration (xref:tinymceai.adoc#options-chat[Chat configuration]).
* API sections cover REST API access (starting at xref:tinymceai-chat.adoc#conversations-api[Conversations API]).
Expand Down Expand Up @@ -265,9 +265,9 @@ After a full page load or new browser session, reopening Chat does not automatic
[[conversations-api]]
== Conversations API

The Chat plugin feature is built on top of the https://tinymceai.api.tiny.cloud/docs#tag/Conversations[Conversations API], which provides REST access to the same conversation functionality described in xref:tinymceai-api-overview.adoc[API Overview]. Conversations support multiple messages with shared context, optional files and web resources, and suggestions that can update editor content.
The Chat plugin feature is built on top of the https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversations[Conversations API], which provides REST access to the same conversation functionality described in xref:tinymceai-api-overview.adoc[API Overview]. Conversations support multiple messages with shared context, optional files and web resources, and suggestions that can update editor content.

For endpoint listings and request or response schemas, start with xref:tinymceai-api-overview.adoc[API Overview] and xref:tinymceai-api-quick-start.adoc[API Quick Start], then use the https://tinymceai.api.tiny.cloud/docs[interactive API documentation] (for example the https://tinymceai.api.tiny.cloud/docs#tag/Conversations[Conversations] operations).
For endpoint listings and request or response schemas, start with xref:tinymceai-api-overview.adoc[API Overview] and xref:tinymceai-api-quick-start.adoc[API Quick Start], then use the https://tinymceai.api.tiny.cloud/v1/docs[interactive API documentation] (for example the https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversations[Conversations] operations).

[[conversations-key-features]]
=== Key Features
Expand All @@ -291,35 +291,35 @@ The AI remembers everything that has been shared and builds on it throughout the

Sending a message through the API takes three requests. The token needs the conversation permissions for each request. See xref:tinymceai-permissions.adoc#conversation-permissions[Conversation permissions].

. https://tinymceai.api.tiny.cloud/docs#tag/Conversations/operation/createConversation[Create the conversation].
. Attach content: an https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Documents/operation/createDocument[HTML document], a https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Files/operation/uploadFile[file], or a https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Web-Resources/operation/downloadWebResources[web page]. File size limits are listed in xref:tinymceai-limits.adoc#file-limits[File limits].
. https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Messages/operation/createMessage[Send the message]. The service streams the reply with Server-Sent Events (SSE). See xref:tinymceai-chat.adoc#conversations-streaming[Streaming responses].
. https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversations/operation/createConversation[Create the conversation].
. Attach content: an https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Documents/operation/createDocument[HTML document], a https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Files/operation/uploadFile[file], or a https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Web-Resources/operation/downloadWebResources[web page]. File size limits are listed in xref:tinymceai-limits.adoc#file-limits[File limits].
. https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Messages/operation/createMessage[Send the message]. The service streams the reply with Server-Sent Events (SSE). See xref:tinymceai-chat.adoc#conversations-streaming[Streaming responses].

[[conversations-api-capabilities]]
=== API capabilities

The `+capabilities+` object of a https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Messages/operation/createMessage[message request] enables web search (`+webSearch+`) and reasoning (`+reasoning+`) for that message. See xref:tinymceai-models.adoc#model-capabilities[Model capabilities] and xref:tinymceai-models.adoc#reasoning[Reasoning].
The `+capabilities+` object of a https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Messages/operation/createMessage[message request] enables web search (`+webSearch+`) and reasoning (`+reasoning+`) for that message. See xref:tinymceai-models.adoc#model-capabilities[Model capabilities] and xref:tinymceai-models.adoc#reasoning[Reasoning].

Web search is separate from the https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Web-Resources[Conversation Web Resources] endpoints, which attach the content of one known URL to the conversation.
Web search is separate from the https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Web-Resources[Conversation Web Resources] endpoints, which attach the content of one known URL to the conversation.

[[conversations-api-stored]]
=== Working with stored conversations

The Chat history in the sidebar shows the conversations and messages that the AI service stores. The following operations read and manage the same data:

* https://tinymceai.api.tiny.cloud/docs#tag/Conversations/operation/getConversations[List conversations].
* https://tinymceai.api.tiny.cloud/docs#tag/Conversations/operation/getConversation[Get a conversation], https://tinymceai.api.tiny.cloud/docs#tag/Conversations/operation/updateConversation[update a conversation] (for example, to rename or pin it), or https://tinymceai.api.tiny.cloud/docs#tag/Conversations/operation/deleteConversation[delete a conversation].
* https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Messages/operation/getMessages[List the messages in a conversation].
* https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversations/operation/getConversations[List conversations].
* https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversations/operation/getConversation[Get a conversation], https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversations/operation/updateConversation[update a conversation] (for example, to rename or pin it), or https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversations/operation/deleteConversation[delete a conversation].
* https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Messages/operation/getMessages[List the messages in a conversation].

[[conversations-streaming]]
=== Streaming Responses

Conversations use Server-Sent Events (SSE) for real-time streaming responses. See the xref:tinymceai-streaming.adoc[Streaming Responses guide] for detailed implementation information and code examples. For the events and their payloads, see https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Messages/operation/createMessage[Send a message] in the API reference.
Conversations use Server-Sent Events (SSE) for real-time streaming responses. See the xref:tinymceai-streaming.adoc[Streaming Responses guide] for detailed implementation information and code examples. For the events and their payloads, see https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Messages/operation/createMessage[Send a message] in the API reference.

[[conversations-api-reference]]
=== API Reference

The https://tinymceai.api.tiny.cloud/docs[interactive API documentation] lists every conversation endpoint, parameter, schema, and example. In that UI, related operations are grouped under tags such as https://tinymceai.api.tiny.cloud/docs#tag/Conversations[Conversations], https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Documents[Conversation Documents], https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Files[Conversation Files], https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Web-Resources[Conversation Web Resources], and https://tinymceai.api.tiny.cloud/docs#tag/Conversation-Messages[Conversation Messages] (including streaming, web search, and reasoning options where applicable).
The https://tinymceai.api.tiny.cloud/v1/docs[interactive API documentation] lists every conversation endpoint, parameter, schema, and example. In that UI, related operations are grouped under tags such as https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversations[Conversations], https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Documents[Conversation Documents], https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Files[Conversation Files], https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Web-Resources[Conversation Web Resources], and https://tinymceai.api.tiny.cloud/v1/docs#tag/Conversation-Messages[Conversation Messages] (including streaming, web search, and reasoning options where applicable).

[[related-features]]
== Related Features
Expand Down
Loading
Loading