Cloudmersive

Cloudmersive Convert Web API

Convert Web operations of the Cloudmersive Document and Data Conversion API — 8 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 8

POST /convert/web/url/to/screenshot Take screenshot of URL #
POST /convert/web/url/to/pdf Convert a URL to PDF #
POST /convert/web/url/to/txt Convert website URL page to text (txt) #
POST /convert/web/html/to/pdf Convert HTML string to PDF #
POST /convert/web/html/to/png Convert HTML string to PNG screenshot #
POST /convert/web/html/to/txt Convert HTML string to text (txt) #
POST /convert/html/to/docx Convert HTML to Word DOCX Document #
POST /convert/web/md/to/html Convert Markdown to HTML #

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-convertweb-api-openapi.yml
⚙
OpenAPI
https://api.cloudmersive.com/convert/docs/v1/swagger

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-html-to-pdf-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-html-to-png-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-screenshot-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-url-to-pdf-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-url-to-text-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-html-to-text-response-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-convertweb-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-convertweb-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: v1
  title: convertapi Convert Web API
  description: Convert API lets you effortlessly convert file formats and types.
servers:
- url: http://localhost
tags:
- name: ConvertWeb
paths:
  /convert/web/url/to/screenshot:
    post:
      tags:
      - ConvertWeb
      summary: Take screenshot of URL
      description: Fully renders a website and returns a PNG screenshot of the full page image. Javascript, HTML5, CSS and other advanced features are all supported.
      operationId: ConvertWeb_UrlToScreenshot
      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:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenshotRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ScreenshotRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/ScreenshotRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/ScreenshotRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ScreenshotRequest'
        description: Screenshot request parameters
        required: true
  /convert/web/url/to/pdf:
    post:
      tags:
      - ConvertWeb
      summary: Convert a URL to PDF
      description: Fully renders a website and returns a PDF of the full page. Javascript, HTML5, CSS and other advanced features are all supported.
      operationId: ConvertWeb_UrlToPdf
      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:
          application/json:
            schema:
              $ref: '#/components/schemas/UrlToPdfRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/UrlToPdfRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/UrlToPdfRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/UrlToPdfRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UrlToPdfRequest'
        description: URL to PDF request parameters
        required: true
  /convert/web/url/to/txt:
    post:
      tags:
      - ConvertWeb
      summary: Convert website URL page to text (txt)
      description: Converts a website URL page into text (txt); extracts text from HTML
      operationId: ConvertWeb_UrlToTxt
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UrlToTextResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/UrlToTextResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/UrlToTextResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/UrlToTextResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UrlToTextRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/UrlToTextRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/UrlToTextRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/UrlToTextRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UrlToTextRequest'
        description: HTML to Text request parameters
        required: true
  /convert/web/html/to/pdf:
    post:
      tags:
      - ConvertWeb
      summary: Convert HTML string to PDF
      description: Fully renders a website and returns a PDF of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
      operationId: ConvertWeb_HtmlToPdf
      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:
          application/json:
            schema:
              $ref: '#/components/schemas/HtmlToPdfRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/HtmlToPdfRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/HtmlToPdfRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/HtmlToPdfRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/HtmlToPdfRequest'
        description: HTML to PDF request parameters
        required: true
  /convert/web/html/to/png:
    post:
      tags:
      - ConvertWeb
      summary: Convert HTML string to PNG screenshot
      description: Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.
      operationId: ConvertWeb_HtmlToPng
      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:
          application/json:
            schema:
              $ref: '#/components/schemas/HtmlToPngRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/HtmlToPngRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/HtmlToPngRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/HtmlToPngRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/HtmlToPngRequest'
        description: HTML to PNG request parameters
        required: true
  /convert/web/html/to/txt:
    post:
      tags:
      - ConvertWeb
      summary: Convert HTML string to text (txt)
      description: Converts an HTML string input into text (txt); extracts text from HTML
      operationId: ConvertWeb_HtmlToTxt
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HtmlToTextResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/HtmlToTextResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/HtmlToTextResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/HtmlToTextResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HtmlToTextRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/HtmlToTextRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/HtmlToTextRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/HtmlToTextRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/HtmlToTextRequest'
        description: HTML to Text request parameters
        required: true
  /convert/html/to/docx:
    post:
      tags:
      - ConvertWeb
      summary: Convert HTML to Word DOCX Document
      description: Convert HTML to Office Word Document (DOCX) format
      operationId: ConvertWeb_HtmlToDocx
      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:
          application/json:
            schema:
              $ref: '#/components/schemas/HtmlToOfficeRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/HtmlToOfficeRequest'
          application/xml:
            schema:
              $ref: '#/components/schemas/HtmlToOfficeRequest'
          text/xml:
            schema:
              $ref: '#/components/schemas/HtmlToOfficeRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/HtmlToOfficeRequest'
        description: HTML input to convert to DOCX
        required: true
  /convert/web/md/to/html:
    post:
      tags:
      - ConvertWeb
      summary: Convert Markdown to HTML
      description: Convert a markdown file (.md) to HTML
      operationId: ConvertWeb_MdToHtml
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HtmlMdResult'
            text/json:
              schema:
                $ref: '#/components/schemas/HtmlMdResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/HtmlMdResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/HtmlMdResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputFile:
                  type: string
                  description: Input file to perform the operation on.
                  format: binary
              required:
              - inputFile
components:
  schemas:
    HtmlToPngRequest:
      description: Details of the HTML to PNG request
      type: object
      properties:
        Html:
          description: HTML to render to PNG (screenshot)
          type: string
        ExtraLoadingWait:
          format: int32
          description: 'Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites. Provide a value of 0 for the default of 5000 milliseconds (5 seconds). Maximum is 30000 milliseconds (30 seconds).'
          type: integer
        ScreenshotWidth:
          format: int32
          description: 'Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot'
          type: integer
        ScreenshotHeight:
          format: int32
          description: 'Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot'
          type: integer
    UrlToTextResponse:
      description: Result of running the URL website to Text operation
      type: object
      properties:
        Successful:
          description: True if successful, false otherwise
          type: boolean
        TextContentResult:
          description: Text content result from the URL website input
          type: string
    HtmlToPdfRequest:
      description: Details of the HTML to PDF request
      type: object
      properties:
        Html:
          description: HTML to render to PDF
          type: string
        ExtraLoadingWait:
          format: int32
          description: 'Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites. Provide a value of 0 for the default of 5000 milliseconds (5 seconds). Maximum is 30000 milliseconds (30 seconds).'
          type: integer
        IncludeBackgroundGraphics:
          description: 'Optional: Set to true to include background graphics in the PDF, or false to not include.  Default is true.'
          type: boolean
        ScaleFactor:
          format: int32
          description: 'Optional: Set to 100 to scale at 100%, set to 50% to scale down to 50% scale, set to 200% to scale up to 200% scale, etc.  Default is 100%. Maximum is 1000%.'
          type: integer
        AutoSanitize:
          description: 'Optional: Automatically sanitize unsafe elements from the input HTML.  If disabled, and unsafe elements remain in the input HTML, the request will be blocked.  Default is true.'
          type: boolean
        PageSize:
          description: 'Optional: Page size for the PDF output.  Default is Letter.  Allowed values: Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6.'
          type: string
    HtmlToOfficeRequest:
      description: Details of the HTML to Office request
      type: object
      properties:
        Html:
          description: HTML to render to Office format
          type: string
    ScreenshotRequest:
      description: Details of the screenshot request
      type: object
      properties:
        Url:
          description: URL address of the website to screenshot.  HTTP and HTTPS are both supported, as are custom ports.
          type: string
        ExtraLoadingWait:
          format: int32
          description: 'Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites.  Provide a value of 0 for the default of 5000 milliseconds (5 seconds). Maximum is 20000 milliseconds (20 seconds).'
          type: integer
        ScreenshotWidth:
          format: int32
          description: 'Optional: Width of the screenshot in pixels; supply 0 to default to 1280 x 1024'
          type: integer
        ScreenshotHeight:
          format: int32
          description: 'Optional: Height of the screenshot in pixels; supply 0 to default to 1280 x 1024, supply -1 to measure the full screen height of the page and attempt to take a screen-height screenshot'
          type: integer
    HtmlMdResult:
      description: Result from converting a Markdown file to HTML
      type: object
      properties:
        Successful:
          description: True if operation was successful, false otherwise
          type: boolean
        Html:
          description: Resulting HTML from the conversion
          type: string
    UrlToTextRequest:
      description: Details of the URL website to Text request
      type: object
      properties:
        Url:
          description: URL of the website to extract the text from
          type: string
    HtmlToTextRequest:
      description: Details of the HTML to Text request
      type: object
      properties:
        Html:
          description: HTML to extract the text from
          type: string
    HtmlToTextResponse:
      description: Result of running the HTML to Text operation
      type: object
      properties:
        Successful:
          description: True if successful, false otherwise
          type: boolean
        TextContentResult:
          description: Text content result from the HTML input
          type: string
    UrlToPdfRequest:
      description: Request to convert a URL to a PDF file
      type: object
      properties:
        Url:
          description: URL address of the website to screenshot.  HTTP and HTTPS are both supported, as are custom ports.
          type: string
        ExtraLoadingWait:
          format: int32
          description: 'Optional: Additional number of milliseconds to wait once the web page has finished loading before taking the screenshot.  Can be helpful for highly asynchronous websites.  Provide a value of 0 for the default of 5000 milliseconds (5 seconds). Maximum is 20000 milliseconds (20 seconds).'
          type: integer
        IncludeBackgroundGraphics:
          description: 'Optional: Set to true to include background graphics in the PDF, or false to not include.  Default is true.'
          type: boolean
        ScaleFactor:
          format: int32
          description: 'Optional: Set to 100 to scale at 100%, set to 50% to scale down to 50% scale, set to 200% to scale up to 200% scale, etc.  Default is 100%. Maximum is 1000%'
          type: integer
  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)