TinyMCE AI REST API 支持在您的应用程序中使用与 TinyMCE AI 插件相同的基础设施进行 AI 集成，但无需绑定编辑器。通过一个 API 即可与多个 AI 代理集成，访问聊天、审查和快速操作功能的所有功能，并使用自定义 UI 和工作流。

API 参考：完整的 API 文档包括所有端点、参数、请求/响应模式以及交互式示例，可在 TinyMCE AI API 文档 中查看。

入门

对 TinyMCE AI 还不熟悉？请从 快速入门 指南开始，设置环境、生成访问凭据并进行第一次 API 调用。

TinyMCE AI 功能

  • 聊天：带有历史记录和持久上下文的交互式 AI 聊天。

  • 审查：内容分析和校对，针对更大内容优化。

  • 快速操作：针对特定任务的快速、无状态操作。

架构

以下页面介绍 AI 服务架构和配置。

  • 模型：AI 模型选择、功能和配置。

  • 流式传输：AI 生成响应的实时流式传输。

  • 权限：如何控制用户对功能的访问。

  • 限制：速率限制、上下文大小限制和文件限制。

版本控制

每个端点的版本都是其路径的一部分，例如 /v1/conversations。TinyMCE AI 插件调用 /v1 端点，并请求兼容版本 1 的模型列表。兼容版本与端点版本是分开的。参见 模型兼容版本。

分页

列表端点使用游标分页。这包括会话列表以及会话的文档、文件和网络资源。API 参考文档记录了每个列表操作的分页参数，例如 获取多个会话。

错误响应

AI 服务返回的错误使用包含以下字段的 JSON 正文：

字段描述

statusCode

HTTP 状态码。

code

机器可读的错误代码，例如 missing-permissions。

message

对错误的简短描述。

traceId

请求的唯一标识符。在联系 Tiny 支持时请包含此标识符。

data

可选。包含特定错误详细信息的对象。

explanation

可选。关于错误发生原因的更多详细信息。

action

可选。建议的下一步操作。

例如，一个没有请求所需权限的令牌返回：

{
  "statusCode": 403,
  "code": "missing-permissions",
  "message": "The user is missing permissions",
  "traceId": "8f3c1c2e-5b7a-4d0e-9a61-2f4c8e0b7d13",
  "data": {
    "missingPermissions": ["ai:conversations:write"]
  }
}

错误代码

API 参考在其 错误代码 部分列出了所有代码。对于令牌错误，请参见 JWT 故障排除。对于 missing-permissions 响应，请参见 权限。

速率限制错误

对于代码为 rate-limits-exceeded 的 429 响应，请参见 处理速率限制错误。

资源和支持