Skip to content

Commit

Permalink
docs: clarify the endpoint a bit more
Browse files Browse the repository at this point in the history
  • Loading branch information
nperez0111 committed Dec 20, 2024
1 parent cb21896 commit bd8e6fc
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/content/collaboration/documents/conversion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,13 @@ Specify how source document elements are mapped to ProseMirror nodes or marks, a

## /import-docx endpoint (experimental)

The `/import-docx` endpoint enables the conversion of `docx` files into Tiptaps JSON format. Users can POST documents to this endpoint and use various parameters to customize how different document elements are handled during the conversion process.
The `/import-docx` endpoint enables the conversion of docx files into Tiptap's JSON format and allows for more docx-specific functions than the /import endpoint. Users can POST documents to this endpoint and use various parameters to customize how different document elements are handled during the conversion process.

- **Method**: `POST`

<Callout title="Alpha" variant="hint">
This feature is currently in alpha and available to all users with a Tiptap account.
This feature is currently in alpha and available to all users with a Tiptap account. Consider this
endpoint experimental and subject to change.
</Callout>

### Required headers
Expand Down

0 comments on commit bd8e6fc

Please sign in to comment.