REST API

Markdown Conversion REST API を使い、ドキュメントを Markdown に変換することもできます。

前提条件: Workers AI の API トークンを取得する

REST API 経由で Markdown Conversion サービスを使うには、Workers AI REST API の権限を持つ API トークンが必要です。正しい権限のトークンの取得手順は、Workers AI REST API を始めるを参照してください。

変換

このエンドポイントは、渡された任意のファイルを Markdown に変換します。

curl https://api.cloudflare.com/client/v4/accounts/{ACCOUNT_ID}/ai/tomarkdown \
  -X POST \
  -H 'Authorization: Bearer {API_TOKEN}' \
  -F "files=@cat.jpeg" \
  -F "files=@somatosensory.pdf" \
  -F 'conversionOptions={ ... }'

パラメーター

files File[] 必須

変換したいファイルです。

conversionOptions ConversionOptions 任意

ファイルの変換方法を制御するオプションです。詳細は変換オプションを参照してください。

レスポンス

{
	"success": true,
	"result": [
		{
			"id": "...",
			"name": "good.html",
			"mimeType": "text/html",
			"format": "markdown",
			"tokens": 49,
			"data": "# Image Embedded with a Data URI\n\nThis _image_ is directly encoded in the HTML:\n\n\n\nAn image description\n\n \n\nIt's a tiny 5x5 pixel PNG, scaled up to 50x50px.\n\n"
		},
		{
			"id": "...",
			"name": "bad.pdf",
			"mimeType": "application/pdf",
			"format": "error",
			"error": "Some error that prevented this image from being converted"
		}
	]
}

対応フォーマット

このエンドポイントは、変換に対応しているリッチフォーマットの一覧をプログラムから取得します。

curl https://api.cloudflare.com/client/v4/accounts/{ACCOUNT_ID}/ai/tomarkdown/supported \
  -H 'Authorization: Bearer {API_TOKEN}'

レスポンス

{
  "success": true,
  "result": [
    {
      "extension": ".html",
      "mimeType": "text/html"
    },
    {
      "extension": ".pdf",
      "mimeType": "application/pdf"
    },
    ...
  ]
}