Convert a document to Markdown

Convert a base64-encoded DOCX, XLSX, PPTX, ODF, EPUB, RTF, CSV, HTML or text file to Markdown with the Webfold document engine. The file travels in the request; the server never fetches a URL for this endpoint. Up to 25 MiB decoded. Metered as documents.convert. Set format or send a filename with a supported extension.

POST/v1/documents/convert

Authorization

AuthorizationBearer token (JWT) · headerrequired

Bearer API key issued for your account. Send Authorization: Bearer <key>.

Request body

requiredapplication/json

content_base64stringrequired

The file, base64 (standard alphabet). Up to 25 MiB decoded.

filenamestring

Used to infer the format from its extension.

formatstring

Overrides the extension in filename.

Allowed:docxdocmpptxxlsxxlsmxlsbxlsodtodpodsepubrtfcsvhtmlhtmtxtmdmarkdown

Responses

200

The document as Markdown

formatstringrequired

bytesintegerrequired

charactersintegerrequired

markdownstringrequired

400

Bad request

string

401

Missing or invalid bearer token

string

403

Billing or plan entitlement blocked the request

string

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

content_base64string*The file, base64 (standard alphabet). Up to 25 MiB decoded.filenamestringUsed to infer the format from its extension.formatstringOverrides the extension in `filename`.

Request

curl -X POST 'https://api.webfold.ai/v1/documents/convert' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "content_base64": "string",
  "filename": "report.docx",
  "format": "docx"
}'

import requests

response = requests.post(
    "https://api.webfold.ai/v1/documents/convert",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"content_base64\": \"string\",\n  \"filename\": \"report.docx\",\n  \"format\": \"docx\"\n}",
)

const response = await fetch("https://api.webfold.ai/v1/documents/convert", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"content_base64\": \"string\",\n  \"filename\": \"report.docx\",\n  \"format\": \"docx\"\n}"
});

Response

{
  "format": "string",
  "bytes": 0,
  "characters": 0,
  "markdown": "string"
}

"string"

"string"

"string"