Export To Docx

curl --request POST \
  --url https://api.example.com/insight/export/docx \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'record_id=<string>' \
  --form locale=ru-RU \
  --form title=Export \
  --form admonition_support=true

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

insight

Export To Docx

Convert Markdown file to DOCX format using Pandoc.

This endpoint accepts a Markdown file and converts it to Microsoft Word (.docx) format with support for custom admonition blocks (ad-info, ad-warning, ad-tip).

Parameters:

file: Markdown file (multipart/form-data)
record_id: Optional record UUID for logging and tracking
locale: Document language (e.g., “ru-RU”, “en-US”)
title: Output filename (without extension)
admonition_support: Enable Lua filters for admonition blocks

Returns:

DOCX file with proper MIME type and Content-Disposition header

Errors:

400: Invalid file or parameters
413: File too large (>8 MB)
500: Conversion failed
504: Conversion timeout (>60s)

POST

insight

export

docx

Export To Docx

curl --request POST \
  --url https://api.example.com/insight/export/docx \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'record_id=<string>' \
  --form locale=ru-RU \
  --form title=Export \
  --form admonition_support=true

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data

file

required

Markdown file to convert

record_id

string | null

Record UUID for logging

locale

string

default:ru-RU

Document language locale

title

string

default:Export

Document title

admonition_support

boolean

default:true

Enable admonition block processing

Response

Successful Response

Get Intro

Export Report To Docx

⌘I

Introduction

API Endpoints

Export To Docx

Authorizations

Body

Response