API Documentation

Use our API to integrate HWP conversion into your applications. All endpoints are free to use with no authentication required.

Base URL

Endpoints

1. Convert to JSON (Recommended)

Returns the converted content as JSON. Supports both file uploads and URL-based conversion.

Parameters:

• format (query): markdown, html, or doc (default: markdown)

The doc format returns Word-flavored HTML that opens natively in Microsoft Word / LibreOffice Writer when saved with a .doc extension.

Request Body (File Upload):

multipart/form-data
file: [HWP file]

Example (File Upload):

curl -X POST https://hangul.io/api/convert-json?format=markdown \
  -F "file=@document.hwp"

Request Body (URL):

{
  "url": "https://example.com/document.hwp",
  "format": "markdown"  // optional, can also use query param
}

Example (URL-based):

curl -X POST https://hangul.io/api/convert-json?format=markdown \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/document.hwp"}'

Response:

{
  "success": true,
  "markdown": "# Document Title\n\nContent..."
}

Or for HTML:

{
  "success": true,
  "html": "<!DOCTYPE html><html>...</html>"
}

2. Convert and Download Files

These endpoints return the converted file directly for download.

Example:

curl -X POST https://hangul.io/api/convert \
  -F "file=@document.hwp" \
  -o output.md

Limits & Requirements

Error Responses

{
  "error": "Error message description"
}

Common errors:

• 400: Invalid file type, no file provided, or invalid URL
• 500: Conversion failed or server error

Support & Contact