← Cloudflare Workers AI / workers-ai / features / markdown-conversion / usage

REST API

Также для преобразования документов в Markdown можно использовать Markdown Conversion REST API.

Необходимое условие: получите API-токен Workers AI

Чтобы использовать сервис Markdown Conversion через REST API, вам понадобится токен API с разрешениями для Workers AI REST API. См. Начало работы с Workers AI REST API с инструкциями о том, как получить API-токен с необходимыми разрешениями.

Преобразование

Эта конечная точка позволяет преобразовать в markdown любой переданный ей файл.

curl https://api.cloudflare.com/client/v4/accounts/{ACCOUNT_ID}/ai/tomarkdown \
  -X POST \
  -H 'Authorization: Bearer {API_TOKEN}' \
  -F "[email protected]" \
  -F "[email protected]" \
  -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"
    },
    ...
  ]
}