> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowengineering.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Convert markdown to rich text JSON

> Converts a markdown string to rich text JSON for use in entity descriptions. Supports standard markdown (headings, bold, italic, lists, code blocks, links, etc.). 

**Embedding files:** Use `![alt text](flow-file:{fileId})` to embed uploaded files. The `fileId` is returned by `POST /files/upload`. Example: `"# Report\n\n![diagram](flow-file:abc-123)"` produces a heading and an embedded image.



## OpenAPI

````yaml /openapi/customer-api.json post /convert/markdown-to-rich-text
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Flow customer API reference. Start with the [quickstart](/api/quickstart)
    and [authentication guide](/api/authentication).
  title: Customer API
  version: 1.0.0
servers:
  - description: Flow API
    url: https://backend.branch.flowengineering.com
security: []
tags:
  - name: Automations
  - name: Branches
  - name: Comments
  - name: Convert
  - name: Data Model
  - name: Diagrams
  - name: Entities
  - name: Files
  - name: Import
  - name: Notifications
  - name: Projects
  - name: ReqIF
  - name: ReqIF Import
  - name: Shared Access Grants
  - name: User Groups
  - name: Users
paths:
  /convert/markdown-to-rich-text:
    post:
      tags:
        - Convert
      summary: Convert markdown to rich text JSON
      description: >-
        Converts a markdown string to rich text JSON for use in entity
        descriptions. Supports standard markdown (headings, bold, italic, lists,
        code blocks, links, etc.). 


        **Embedding files:** Use `![alt text](flow-file:{fileId})` to embed
        uploaded files. The `fileId` is returned by `POST /files/upload`.
        Example: `"# Report\n\n![diagram](flow-file:abc-123)"` produces a
        heading and an embedded image.
      operationId: ConvertController_markdownToRichText
      parameters:
        - description: Workspace identifier
          in: header
          name: customer
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkdownToRichTextDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  richText:
                    type: array
                type: object
          description: Rich text JSON array
      security:
        - api-key: []
        - bearer: []
components:
  schemas:
    MarkdownToRichTextDto:
      properties:
        markdown:
          description: Markdown string to convert to rich text JSON
          type: string
      required:
        - markdown
      type: object
  securitySchemes:
    api-key:
      in: header
      name: X-API-Key
      type: apiKey
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````