openapi: 3.0.3 info: title: HTML to Markdown Converter API version: "1.0.0" description: | Convert HTML or a public URL into clean Markdown (ATX headers, fenced code blocks). Ideal for content migration, blogging tools, static site generators, and automation pipelines. **Auth:** Include `x-functions-key` header. **Notes:** For URL mode, content is converted from the fetched HTML source. Client-rendered content may not appear unless present in the server response. **Contact:** support@example.com termsOfService: https://example.com/terms license: name: MIT servers: - url: https://YOUR_FUNCTION_APP.azurewebsites.net description: Azure Functions Production tags: - name: Content Conversion - name: Utilities - name: Markdown paths: /api/html-to-markdown: get: tags: [Content Conversion] summary: Convert a live page (URL) to Markdown description: Convert an online HTML page to Markdown by providing a publicly accessible URL. security: - functionsKey: [] parameters: - in: query name: url required: true schema: type: string format: uri description: Publicly accessible URL to convert responses: "200": description: Markdown output content: text/markdown: schema: type: string examples: sample: summary: Markdown Example value: | # Example Domain This domain is for use in illustrative examples in documents. "400": description: Invalid or missing URL content: application/json: schema: type: object properties: error: { type: string } examples: invalid: value: { error: "Provide ?url= or POST { html: \"...\" }" } "500": description: Server error x-codeSamples: - lang: cURL label: curl source: | curl -s "https://YOUR_FUNCTION_APP.azurewebsites.net/api/html-to-markdown?url=https://example.com" \ -H "x-functions-key: " - lang: JavaScript label: fetch() source: | const res = await fetch("https://YOUR_FUNCTION_APP.azurewebsites.net/api/html-to-markdown?url=https://example.com", { headers: { "x-functions-key": "" } }); const md = await res.text(); post: tags: [Content Conversion] summary: Convert raw HTML to Markdown description: Post raw HTML or a JSON body with a `url` and receive Markdown. security: - functionsKey: [] requestBody: required: true content: application/json: schema: oneOf: - type: object properties: html: type: string description: Raw HTML string to convert required: [html] additionalProperties: false - type: object properties: url: type: string format: uri description: Publicly accessible URL to fetch and convert required: [url] additionalProperties: false examples: htmlExample: summary: Raw HTML value: html: "

Hello

This is Markdown.

" urlExample: summary: JSON body with URL value: url: "https://example.com" responses: "200": description: Markdown output content: text/markdown: schema: type: string examples: md: value: | # Hello This is **Markdown**. "400": description: Invalid body or fetch error content: application/json: schema: type: object properties: error: { type: string } examples: invalid: value: { error: "Provide ?url= or POST { html: \"...\" }" } "500": description: Server error x-codeSamples: - lang: cURL label: curl source: | curl -s -X POST "https://YOUR_FUNCTION_APP.azurewebsites.net/api/html-to-markdown" \ -H "x-functions-key: " \ -H "Content-Type: application/json" \ -d '{"html":"

Hello

This is Markdown.

"}' - lang: Python label: requests source: | import requests, json url = "https://YOUR_FUNCTION_APP.azurewebsites.net/api/html-to-markdown" headers = {"x-functions-key":"", "Content-Type":"application/json"} payload = {"html":"

Hello

This is Markdown.

"} r = requests.post(url, headers=headers, data=json.dumps(payload)) print(r.text) components: securitySchemes: functionsKey: type: apiKey in: header name: x-functions-key