Cloudmersive

Cloudmersive Edit Html API

Edit Html operations of the Cloudmersive Document and Data Conversion API — 13 operation(s) served from https://api.cloudmersive.com and authenticated with the Apikey header. One Cloudmersive API key grants access to every API in the portfolio.

GitHub OpenAPI

Operations 13

POST /convert/edit/html/append/heading Append a Heading to an HTML Document #
POST /convert/edit/html/head/append/tag Append an HTML tag to the HEAD section of an HTML Document #
POST /convert/edit/html/head/get/language Gets the language for the HTML document #
POST /convert/edit/html/head/set/language Sets the language for the HTML document #
POST /convert/edit/html/head/set/rel-canonical-url Sets the rel canonical URL for the HTML document #
POST /convert/edit/html/head/get/rel-canonical-url Gets the rel canonical URL for the HTML document #
POST /convert/edit/html/head/get/sitemap-url Gets the sitemap URL for the HTML document #
POST /convert/edit/html/head/set/sitemap-url Sets the sitemap URL for the HTML document #
POST /convert/edit/html/append/paragraph Append a Paragraph to an HTML Document #
POST /convert/edit/html/append/image/from-url Append an Image to an HTML Document from a URL #
POST /convert/edit/html/append/image/inline Append a Base64 Inline Image to an HTML Document #
POST /convert/edit/html/create/blank Create a Blank HTML Document #

Documentation

📖
Documentation
https://api.cloudmersive.com/docs/convert.asp
📖
APIReference
https://api-console.cloudmersive.com/swagger/index.html?urls.primaryName=Convert%20API

Specifications

⚙
OpenAPI
https://artifacts.apis.io/cloudmersive/openapi/cloudmersive-edithtml-api-openapi.yml
⚙
OpenAPI
https://api.cloudmersive.com/convert/docs/v1/swagger

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-html-get-links-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-html-get-language-result-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-html-get-rel-canonical-url-result-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-html-get-sitemap-url-result-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cloudmersive:cloudmersive-edithtml-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudmersive-edithtml-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: v1
  title: convertapi Edit Html API
  description: Convert API lets you effortlessly convert file formats and types.
servers:
- url: http://localhost
tags:
- name: EditHtml
paths:
  /convert/edit/html/append/heading:
    post:
      tags:
      - EditHtml
      summary: Append a Heading to an HTML Document
      description: Appends a heading to the end of an HTML document.
      operationId: EditHtml_HtmlAppendHeading
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      - name: headingText
        in: header
        description: The text content to be used in the header.
        required: true
        schema:
          type: string
      - name: headingSize
        in: header
        description: 'Optional: The heading size number. Default is 1. Accepts values between 1 and 6.'
        required: false
        schema:
          type: integer
      - name: cssStyle
        in: header
        description: 'Optional: The CSS style for the heading.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            application/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/edit/html/head/append/tag:
    post:
      tags:
      - EditHtml
      summary: Append an HTML tag to the HEAD section of an HTML Document
      description: Appends an HTML tag to the HEAD section of an HTML document.
      operationId: EditHtml_HtmlAppendHeaderTag
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      - name: htmlTag
        in: header
        description: The HTML tag to append.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            application/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/edit/html/head/get/language:
    post:
      tags:
      - EditHtml
      summary: Gets the language for the HTML document
      description: Retrieves the language code (e.g. "en" or "de") of an HTML document.
      operationId: EditHtml_HtmlGetLanguage
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HtmlGetLanguageResult'
            text/json:
              schema:
                $ref: '#/components/schemas/HtmlGetLanguageResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/HtmlGetLanguageResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/HtmlGetLanguageResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/edit/html/head/set/language:
    post:
      tags:
      - EditHtml
      summary: Sets the language for the HTML document
      description: Sets the language code of an HTML document.
      operationId: EditHtml_HtmlSetLanguage
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      - name: languageCode
        in: header
        description: The HTML langauge code to set.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            application/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/edit/html/head/set/rel-canonical-url:
    post:
      tags:
      - EditHtml
      summary: Sets the rel canonical URL for the HTML document
      description: Sets the rel canonical URL of an HTML document. This is useful for telling search engines and other indexers which pages are duplicates of eachother; any pages with the rel=canonical tag will be treated as duplicates of the canonical URL.
      operationId: EditHtml_HtmlSetRelCanonical
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      - name: canonicalUrl
        in: header
        description: The HTML canonical URL to set.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            application/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/edit/html/head/get/rel-canonical-url:
    post:
      tags:
      - EditHtml
      summary: Gets the rel canonical URL for the HTML document
      description: Gets the rel canonical URL of an HTML document.
      operationId: EditHtml_HtmlGetRelCanonical
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HtmlGetRelCanonicalUrlResult'
            text/json:
              schema:
                $ref: '#/components/schemas/HtmlGetRelCanonicalUrlResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/HtmlGetRelCanonicalUrlResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/HtmlGetRelCanonicalUrlResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/edit/html/head/get/sitemap-url:
    post:
      tags:
      - EditHtml
      summary: Gets the sitemap URL for the HTML document
      description: Gets the sitemap link URL of an HTML document.
      operationId: EditHtml_HtmlGetSitemap
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HtmlGetSitemapUrlResult'
            text/json:
              schema:
                $ref: '#/components/schemas/HtmlGetSitemapUrlResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/HtmlGetSitemapUrlResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/HtmlGetSitemapUrlResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/edit/html/head/set/sitemap-url:
    post:
      tags:
      - EditHtml
      summary: Sets the sitemap URL for the HTML document
      description: Sets the sitemap URL of an HTML document.
      operationId: EditHtml_HtmlSetSitemapUrl
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      - name: sitemapUrl
        in: header
        description: The HTML sitemap URL to set.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            application/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/edit/html/append/paragraph:
    post:
      tags:
      - EditHtml
      summary: Append a Paragraph to an HTML Document
      description: Appends a paragraph to the end of an HTML document.
      operationId: EditHtml_HtmlAppendParagraph
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      - name: paragraphText
        in: header
        description: The text content to be used in the paragraph.
        required: true
        schema:
          type: string
      - name: cssStyle
        in: header
        description: 'Optional: The CSS style for the paragraph.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            application/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/edit/html/extract/links:
    post:
      tags:
      - EditHtml
      summary: Extract resolved link URLs from HTML File
      description: Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
      operationId: EditHtml_HtmlGetLinks
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      - name: baseUrl
        in: header
        description: 'Optional: Base URL of the page, such as https://mydomain.com'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HtmlGetLinksResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/HtmlGetLinksResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/HtmlGetLinksResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/HtmlGetLinksResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/edit/html/append/image/from-url:
    post:
      tags:
      - EditHtml
      summary: Append an Image to an HTML Document from a URL
      description: Appends an image to the end of an HTML document using a URL.
      operationId: EditHtml_HtmlAppendImageFromUrl
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      - name: imageUrl
        in: header
        description: The URL for the image.
        required: true
        schema:
          type: string
      - name: cssStyle
        in: header
        description: 'Optional: CSS style for the image.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            application/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
  /convert/edit/html/append/image/inline:
    post:
      tags:
      - EditHtml
      summary: Append a Base64 Inline Image to an HTML Document
      description: Appends a base64 inline image to the end of an HTML document from an input file or URL.
      operationId: EditHtml_HtmlAppendImageInline
      parameters:
      - name: inputFileUrl
        in: header
        description: 'Optional: URL of a file to operate on as input.'
        required: false
        schema:
          type: string
      - name: imageUrl
        in: header
        description: 'Optional: Image URL to be appended as base64 inline image.'
        required: false
        schema:
          type: string
      - name: cssStyle
        in: header
        description: 'Optional: CSS style for the image.'
        required: false
        schema:
          type: string
      - name: imageExtension
        in: header
        description: 'Optional: The extension (JPG, PNG, GIF, etc.) of the image file. Recommended if uploading an imageFile directly, instead of using imageUrl. If no extension can be determined, will default to JPG.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            application/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: 'Optional: Input file to perform the operation on.'
                  format: binary
                imageFile:
                  type: string
                  description: 'Optional: Image file to be appended as base64 inline image.'
                  format: binary
  /convert/edit/html/create/blank:
    post:
      tags:
      - EditHtml
      summary: Create a Blank HTML Document
      description: Returns a blank HTML Document format file. The file is blank, with no contents by default. Use the optional input parameters to add various starting elements. Use additional editing commands such as Append Header, Append Paragraph or Append Image from URL to populate the document.
      operationId: EditHtml_HtmlCreateBlankDocument
      parameters:
      - name: title
        in: header
        description: 'Optional: The title of the HTML document'
        required: false
        schema:
          type: string
      - name: cssUrl
        in: header
        description: 'Optional: A CSS style URL to be added to the document.'
        required: false
        schema:
          type: string
      - name: cssInline
        in: header
        description: 'Optional: An inline CSS style to be added to the document.'
        required: false
        schema:
          type: string
      - name: javascriptUrl
        in: header
        description: 'Optional: Javascript URL to be added to the document.'
        required: false
        schema:
          type: string
      - name: javascriptInline
        in: header
        description: 'Optional: Inline Javascript to be added to the document.'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/json:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            application/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
            text/xml:
              schema:
                format: byte
                title: OutputContent
                description: Output file content from the operation
                type: string
      security:
      - Apikey: []
components:
  schemas:
    HtmlHyperlink:
      description: Individual hyperlink in an HTML File
      type: object
      properties:
        Anchortext:
          description: Anchor text of the hyperlink, e.g. Click Here
          type: string
        Url:
          description: URL of the hyperlink; fully-qualified if possible, otherwise relative
          type: string
    HtmlGetSitemapUrlResult:
      description: Result of getting the sitemap URL of the input HTML document
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        CanonicalUrl:
          description: HTML sitemap URL if present
          type: string
    HtmlGetLanguageResult:
      description: Result of getting the language of the input HTML document
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        LanguageCode:
          description: HTML language code of the HTML document, e.g. "en" or "de"
          type: string
    HtmlGetRelCanonicalUrlResult:
      description: Result of getting the canonical URL of the input HTML document
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        CanonicalUrl:
          description: HTML canonical URL if present
          type: string
    HtmlGetLinksResponse:
      description: Result of extracting links from an HTML file
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        Links:
          description: All hyperlinks in the HTML document
          type: array
          items:
            $ref: '#/components/schemas/HtmlHyperlink'
  securitySchemes:
    Apikey:
      type: apiKey
      description: API Key Authentication
      name: Apikey
      in: header
x-provenance:
  method: harvested
  publisher: Cloudmersive
  source: https://api.cloudmersive.com/convert/docs/v1/swagger
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)