Convert files to Markdown with one API

Endpoints

Convert a file from its URL

POST a JSON object with file_url (alias: url) instead of uploading file. Optional filename supplies the original file name when the URL has no extension. output_format accepts markdown or text. Each request converts one file using the same Word2MD API key, daily allowance and credit billing as uploads.

curl -X POST https://www.word2md.net/api/v1/convert \
  -H "Authorization: Bearer sk-your-key" \
  -H "Content-Type: application/json" \
  -d '{"file_url":"https://files.example.com/report.pdf","filename":"report.pdf","output_format":"markdown"}'

Use a public HTTPS direct download URL or a valid signed URL on port 443. Login pages, browser cookies, custom download headers and private networks are not supported. Downloads are limited to 50 MB, 60 seconds and 5 redirects. File URLs are not stored. Download or conversion failures do not count as successful API usage; reserved paid credits are refunded.

HTTP actions in Feishu Base and other automation tools

Use POST with Form URL Encoded (application/x-www-form-urlencoded), add Authorization: Bearer YOUR_WORD2MD_API_KEY, then map file_url to the download URL and filename to the file name. Set output_format to markdown and write the JSON response content field back to your table. Form encoding preserves signed URL characters without manually building JSON.

curl -X POST https://www.word2md.net/api/v1/convert \
  -H "Authorization: Bearer sk-your-key" \
  --data-urlencode "file_url=https://files.example.com/report.pdf" \
  --data-urlencode "filename=report.pdf" \
  --data-urlencode "output_format=markdown"

A Feishu attachment preview link is not a public download URL. First obtain a temporary download URL using a Feishu app with permission to read the file, then pass that URL to Word2MD. Do not send Feishu cookies or tokens to Word2MD. Process multiple attachments one request at a time.

Supported file types

The API accepts common office documents, PDFs, spreadsheets, presentations, structured data, media, archives, and images.

Quota and billing

Every account receives a daily API allowance. After the included allowance is used, successful conversions consume one credit from an active subscription balance or a one-time credit pack.

Response format

Successful conversions return the converted content, original filename, output format, credits charged, and updated usage.

{
  "success": true,
  "object": "conversion",
  "content": "# Report\n\n...",
  "format": "markdown",
  "filename": "report.pdf",
  "credits_charged": 0,
  "usage": { "tier": "free", "used": 1, "daily": 50, "remaining": 49 }
}

Errors and status codes

Errors are returned as JSON with a stable error code and a human-readable message.

Production best practices

• Use HTTPS and store keys in environment variables
• Validate file size before upload
• Retry transient 5xx responses with exponential backoff
• Read the usage object to track remaining quota
• Remove sensitive files after processing

API frequently asked questions