catalogue / tools / Documents / DOCX to Markdown API

DOCX to Markdown API

Converts a Word .docx to Markdown, surfacing anything that did not translate as warnings.

Endpoint
POST /v1/docx-to-markdown
Price
$0.005 per call
Family
Documents

01When to use it

  • A faithful docx→Markdown conversion needs a real OOXML engine plus a hardened fetch: an agent that fetches the URL itself walks past every SSRF control, and carrying mammoth per call is not something an agent does inline.
  • Your source is DOCX and you need Markdown.

When not to use it

  • The input is over 25 MB (26,214,400 bytes): docx-to-markdown answers too_large (413).
  • The destination needs more than 40 s to answer: the call ends with upstream_timeout (424).
  • The destination is on a private or local network: the network guard refuses it with blocked_target (403).

02Parameters

FieldTypeRequiredDescription
urlstringyesAbsolute http(s) URL of the .docx, up to 2048 characters; redirects are followed, the body must be a zip, and mammoth must find a Word document in it.

03Limits

LimitValue
Largest source file25 MB (26,214,400 bytes)
Timeout40 s
Source formatsDOCX
Output formatsMarkdown

04Example

The published example of docx-to-markdown, verbatim: the request body and the response it returns.

Request
POST /v1/docx-to-markdown
content-type: application/json
payment-signature: <base64 x402 payload>

{
  "url": "https://grist.tools/samples/documents/garden-handbook.docx"
}
Response
200 OK
payment-response: <base64 settlement receipt>

{
  "source_url": "https://grist.tools/samples/documents/garden-handbook.docx",
  "chars": 341,
  "warnings": [],
  "markdown": "# Community Garden Handbook\n\nPlots are assigned for **one season** and renewed each spring.\n\n## Watering\n\n-   Water early in the morning.\n-   Use the rain barrels first.\n-   Log each watering on the shed board.\n\n## Tools\n\nReturn every tool to the shed _before sunset_.\n\nThe seasonal calendar lives on [the garden site](https://grist.tools/)."
}

Sample file: documents/garden-handbook.docx. One-page Word document (community garden handbook): two heading levels, bold and italic runs, a three-item bullet list and one external link, hand-written OOXML with pinned zip dates.

The returned Markdown splits into 7 blocks separated by blank lines, with 3 headings (1 at level 1, 2 at level 2) reading "Community Garden Handbook", "Watering" and "Tools" and 3 bullet list items. Plain paragraphs make up 3 blocks, the first reading "Plots are assigned for **one season** and renewed each spring." and the last "The seasonal calendar lives on [the garden site](https://grist.tools/)." Its headings total 5 words, its paragraphs 29 words.

Response fieldTypeIn the example
source_urlstring"https://grist.tools/samples/documents/garden-handbook.docx"
charsnumber341
warningsarray0 items
markdownstringa string of 341 characters

05Call it from code

JavaScript
// docx-to-markdown: $0.005 per call, paid in USD Coin on eip155:8453 via x402
// Install: npm install @x402/fetch@2 @x402/evm@2 viem@2
// Save as client.mjs (ES module, Node 18+), export EVM_PRIVATE_KEY with the paying wallet's key in your shell, then run: node client.mjs
// The wrapper reads the 402 (payment-required), signs and retries with payment-signature.
import { wrapFetchWithPayment, x402Client, decodePaymentResponseHeader } from '@x402/fetch'
import { ExactEvmScheme } from '@x402/evm/exact/client'
import { privateKeyToAccount } from 'viem/accounts'

const account = privateKeyToAccount(process.env.EVM_PRIVATE_KEY)
const client = new x402Client().register('eip155:8453', new ExactEvmScheme(account))
const fetchWithPayment = wrapFetchWithPayment(fetch, client)

const body = {
  "url": "https://grist.tools/samples/documents/garden-handbook.docx"
}

const res = await fetchWithPayment('https://grist.tools/v1/docx-to-markdown', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify(body),
})
console.log(res.status, await res.json())
const settle = res.headers.get('payment-response')
if (settle) console.log(decodePaymentResponseHeader(settle).transaction)
Python
# docx-to-markdown: $0.005 per call, paid in USD Coin on eip155:8453 via x402
# Install: pip install "x402[requests,evm]>=2.24,<3"
# The session reads the 402 (payment-required), signs and retries with payment-signature.
import os
from eth_account import Account
from x402 import x402ClientSync
from x402.http import decode_payment_response_header
from x402.http.clients.requests import x402_requests
from x402.mechanisms.evm.exact import register_exact_evm_client
from x402.mechanisms.evm.signers import EthAccountSigner

account = Account.from_key(os.environ["EVM_PRIVATE_KEY"])
client = x402ClientSync()
register_exact_evm_client(client, EthAccountSigner(account), networks="eip155:8453")
session = x402_requests(client)

payload = {
    "url": "https://grist.tools/samples/documents/garden-handbook.docx"
}

res = session.post("https://grist.tools/v1/docx-to-markdown", json=payload)
print(res.status_code, res.json())
settle = res.headers.get("payment-response")
if settle:
    print(decode_payment_response_header(settle).transaction)
curl
# docx-to-markdown: $0.005 per call, paid in USD Coin on eip155:8453 via x402
# 1. Unpaid call: HTTP 402, the requirements in the payment-required header (base64 JSON) and in the body.
curl -i -X POST 'https://grist.tools/v1/docx-to-markdown' -H 'content-type: application/json' -d '{"url":"https://grist.tools/samples/documents/garden-handbook.docx"}'

# 2. Same call with the signed payment (an EIP-3009 authorization, EIP-712 signed: it cannot be
#    typed by hand). x-payment is accepted as the v1 alternative. HTTP 200 carries payment-response.
curl -i -X POST 'https://grist.tools/v1/docx-to-markdown' -H 'content-type: application/json' -H 'payment-signature: <base64 x402 payload>' -d '{"url":"https://grist.tools/samples/documents/garden-handbook.docx"}'

06Errors

CodeHTTPFor this service
invalid_input400The body does not match the schema; its fields are url.
blocked_target403
unreachable_target424
upstream_timeout424
unsupported_content_type415The source is not a type docx-to-markdown reads; it reads DOCX.
too_large413
unprocessable422
internal500

Input that is rejected before the tool runs (malformed JSON, schema mismatch, body over the size limit) is never charged.

When each code is raised, and what it means for payment: /docs/docx-to-markdown.

07Conversions

ConversionRecorded sampleSource sizeOutput size
DOCX to Markdowndocuments/garden-handbook.docx2.8 KB341 bytes

08Questions

How much does a docx-to-markdown call cost?
$0.005 per call, paid in USDC on Base via x402, with no account and no API key.
What does docx-to-markdown return?
A JSON object with 4 top-level fields: source_url, chars, warnings and markdown. The example on this page is a real call over documents/garden-handbook.docx.
What happens when a docx-to-markdown call fails?
The tool answers with a typed JSON error from the errors table. Payment is settled only after the tool has produced its result; a call that fails inside the tool is never settled. A 503 upstream_unavailable can follow a settled call; the x402 payments guide covers it, 429, 402 and an uncertain 500.

09Related