---
title: "Import Docx To Yomu Document"
method: POST
path: "/import_docx_to_yomu_document"
---

# Import Docx To Yomu Document

`POST /import_docx_to_yomu_document`

## Request

- Base URL: `https://api.yomu.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.yomu.ai/import_docx_to_yomu_document`
- Auth: API key in header `ACCESS_TOKEN`

Import a DOCX file from URL (S3 or any link) and convert it to Yomu document in TipTap format.

Args:
    import_request: Contains url (link to DOCX file) and isProduction flag
    
Returns:
    dict: Contains the TipTap JSON document, title, and any error message

## Request body

- ImportDocxToYomuDocumentRequest
  - `url` string, required
  - `isProduction` boolean, nullable
  - `is_revise` boolean, nullable
  - `try_including_citations` boolean, nullable
  - `user_prompt` string, nullable
  - `document_public_id` string, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/yomu/apis/yomu-api.md) - [All operations](https://skmtc.dev/yomu/apis/yomu-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yomu/apis/yomu-api/revisions/eff015f3726e?raw)