GitLab Markdown API

openapi: 3.2.0
info:
  title: GitLab REST Markdown API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Markdown
  description: 'Use this API to render Markdown content as HTML.


    All requests to this API must be authenticated.


    > [!note]

    > The availability of this feature is controlled by a feature flag.

    > This feature is available for testing, but not ready for production use.'
  x-displayName: Markdown
  externalDocs:
    url: https://docs.gitlab.com/api/markdown/
paths:
  /api/v4/markdown:
    post:
      operationId: postApiV4Markdown
      summary: Render Markdown content
      description: Renders Markdown content as HTML.
      tags:
      - Markdown
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesMarkdown'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4MarkdownRequest'
components:
  schemas:
    postApiV4MarkdownRequest:
      type: object
      properties:
        text:
          type:
          - string
          - 'null'
          description: Markdown text to render.
        gfm:
          type: boolean
          description: Render text using GitLab Flavored Markdown.
          default: false
        project:
          type:
          - string
          - 'null'
          description: Project used as context when creating references with GitLab Flavored Markdown.
      required:
      - text
    APIEntitiesMarkdown:
      type: object
      properties:
        html:
          type: string
          example: <p dir=\"auto\">Hello world!</p>"
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header