Convert ODT files via REST API
The ODT document conversion API supports conversion from and to Tiptap’s JSON format.
Review the postman collection
You can also experiment with the Document Conversion API by heading over to our Postman Collection.
Import API endpoint
POST /import
The /import endpoint enables the conversion of ODT files into Tiptap’s JSON format. Users can POST documents to this endpoint.
Example (cURL)
curl -X POST "https://api.tiptap.dev/v1/import" \
-H "Authorization: Bearer <your-jwt-token>" \
-H "X-App-Id: <your-app-id>" \
-F "file=@/path/to/document.odt"
In this example, the request uploads an ODT file
Required headers
| Name | Description |
|---|---|
Authorization | The JWT token to authenticate the request. Example: Bearer your-jwt-token |
X-App-Id | The Convert App-ID from the Collaboration settings page: https://cloud.tiptap.dev/convert-settings |
Body
| Name | Type | Description |
|---|---|---|
file | File | The file to convert |
imageUploadCallbackUrl | string | The callback endpoint to upload images that were encountered within the uploaded document, see more info |
Export API endpoint
POST /export
The /export endpoint converts Tiptap documents back into the docx format.
Required headers
| Name | Description |
|---|---|
Authorization | The JWT token to authenticate the request. Example: Bearer your-jwt-token |
X-App-Id | The Convert App-ID from the Collaboration settings page: https://cloud.tiptap.dev/convert-settings |
Body
| Name | Type | Description |
|---|---|---|
content | Object | The Tiptap document |
format | string | The format to convert to, should be odt |