通过 REST API 转换 ODT 文件

Available in Start planBeta

ODT 文档转换 API 支持从和转换到 Tiptap 的 JSON 格式。

查看 Postman 集合

您还可以通过访问我们的Postman 集合来体验文档转换 API。

导入 API 端点

POST /import

/import 端点使得将 ODT 文件转换为 Tiptap 的 JSON 格式成为可能。用户可以向此端点 POST 文档。

示例 (cURL)

curl -X POST "https://api.tiptap.dev/v1/convert/import" \
  -H "Authorization: Bearer <your-jwt-token>" \
  -H "X-App-Id: <your-app-id>" \
  -F "file=@/path/to/document.odt"

在此示例中，请求上传了一个 ODT 文件。

必需的请求头

名称	描述
`Authorization`	用于验证请求的 JWT 令牌。示例：`Bearer your-jwt-token`
`X-App-Id`	来自协作设置页面的 Convert App-ID：https://cloud.tiptap.dev/convert-settings

请求体

名称	类型	描述
`file`	`File`	要转换的文件
`imageUploadCallbackUrl`	`string`	用于上传在上传的文档中遇到的图像的回调端点，查看更多信息

导出 API 端点

POST /export

/export 端点将 Tiptap 文档转换回 docx 格式。

必需的请求头

名称	描述
`Authorization`	用于验证请求的 JWT 令牌。示例：`Bearer your-jwt-token`
`X-App-Id`	来自协作设置页面的 Convert App-ID：https://cloud.tiptap.dev/convert-settings

请求体

名称	类型	描述
`content`	`Object`	Tiptap 文档
`format`	`string`	要转换的格式，应为 `odt`