cloudmersive_convert_api_client.ConvertWebApi

All URIs are relative to https://api.cloudmersive.com

Method	HTTP request	Description
convert_web_html_to_docx	POST /convert/html/to/docx	Convert HTML to Word DOCX Document
convert_web_html_to_pdf	POST /convert/web/html/to/pdf	Convert HTML string to PDF
convert_web_html_to_png	POST /convert/web/html/to/png	Convert HTML string to PNG screenshot
convert_web_html_to_txt	POST /convert/web/html/to/txt	Convert HTML string to text (txt)
convert_web_md_to_html	POST /convert/web/md/to/html	Convert Markdown to HTML
convert_web_url_to_pdf	POST /convert/web/url/to/pdf	Convert a URL to PDF
convert_web_url_to_screenshot	POST /convert/web/url/to/screenshot	Take screenshot of URL
convert_web_url_to_txt	POST /convert/web/url/to/txt	Convert website URL page to text (txt)

convert_web_html_to_docx

str convert_web_html_to_docx(input_request)

Convert HTML to Word DOCX Document

Convert HTML to Office Word Document (DOCX) format

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.ConvertWebApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_request = cloudmersive_convert_api_client.HtmlToOfficeRequest() # HtmlToOfficeRequest | HTML input to convert to DOCX

try:
    # Convert HTML to Word DOCX Document
    api_response = api_instance.convert_web_html_to_docx(input_request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConvertWebApi->convert_web_html_to_docx: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_request	HtmlToOfficeRequest	HTML input to convert to DOCX

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

convert_web_html_to_pdf

str convert_web_html_to_pdf(input)

Convert HTML string to PDF

Fully renders a website and returns a PDF of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.ConvertWebApi(cloudmersive_convert_api_client.ApiClient(configuration))
input = cloudmersive_convert_api_client.HtmlToPdfRequest() # HtmlToPdfRequest | HTML to PDF request parameters

try:
    # Convert HTML string to PDF
    api_response = api_instance.convert_web_html_to_pdf(input)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConvertWebApi->convert_web_html_to_pdf: %s\n" % e)

Parameters

Name	Type	Description	Notes
input	HtmlToPdfRequest	HTML to PDF request parameters

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

convert_web_html_to_png

str convert_web_html_to_png(input)

Convert HTML string to PNG screenshot

Fully renders a website and returns a PNG (screenshot) of the HTML. Javascript, HTML5, CSS and other advanced features are all supported.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.ConvertWebApi(cloudmersive_convert_api_client.ApiClient(configuration))
input = cloudmersive_convert_api_client.HtmlToPngRequest() # HtmlToPngRequest | HTML to PNG request parameters

try:
    # Convert HTML string to PNG screenshot
    api_response = api_instance.convert_web_html_to_png(input)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConvertWebApi->convert_web_html_to_png: %s\n" % e)

Parameters

Name	Type	Description	Notes
input	HtmlToPngRequest	HTML to PNG request parameters

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

convert_web_html_to_txt

HtmlToTextResponse convert_web_html_to_txt(input)

Convert HTML string to text (txt)

Converts an HTML string input into text (txt); extracts text from HTML

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.ConvertWebApi(cloudmersive_convert_api_client.ApiClient(configuration))
input = cloudmersive_convert_api_client.HtmlToTextRequest() # HtmlToTextRequest | HTML to Text request parameters

try:
    # Convert HTML string to text (txt)
    api_response = api_instance.convert_web_html_to_txt(input)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConvertWebApi->convert_web_html_to_txt: %s\n" % e)

Parameters

Name	Type	Description	Notes
input	HtmlToTextRequest	HTML to Text request parameters

Return type

HtmlToTextResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

convert_web_md_to_html

HtmlMdResult convert_web_md_to_html(input_file)

Convert Markdown to HTML

Convert a markdown file (.md) to HTML

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.ConvertWebApi(cloudmersive_convert_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.

try:
    # Convert Markdown to HTML
    api_response = api_instance.convert_web_md_to_html(input_file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConvertWebApi->convert_web_md_to_html: %s\n" % e)

Parameters

Name	Type	Description	Notes
input_file	file	Input file to perform the operation on.

Return type

HtmlMdResult

Authorization

Apikey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

convert_web_url_to_pdf

str convert_web_url_to_pdf(input)

Convert a URL to PDF

Fully renders a website and returns a PDF of the full page. Javascript, HTML5, CSS and other advanced features are all supported.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.ConvertWebApi(cloudmersive_convert_api_client.ApiClient(configuration))
input = cloudmersive_convert_api_client.UrlToPdfRequest() # UrlToPdfRequest | URL to PDF request parameters

try:
    # Convert a URL to PDF
    api_response = api_instance.convert_web_url_to_pdf(input)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConvertWebApi->convert_web_url_to_pdf: %s\n" % e)

Parameters

Name	Type	Description	Notes
input	UrlToPdfRequest	URL to PDF request parameters

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

convert_web_url_to_screenshot

str convert_web_url_to_screenshot(input)

Take screenshot of URL

Fully renders a website and returns a PNG screenshot of the full page image. Javascript, HTML5, CSS and other advanced features are all supported.

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.ConvertWebApi(cloudmersive_convert_api_client.ApiClient(configuration))
input = cloudmersive_convert_api_client.ScreenshotRequest() # ScreenshotRequest | Screenshot request parameters

try:
    # Take screenshot of URL
    api_response = api_instance.convert_web_url_to_screenshot(input)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConvertWebApi->convert_web_url_to_screenshot: %s\n" % e)

Parameters

Name	Type	Description	Notes
input	ScreenshotRequest	Screenshot request parameters

Return type

str

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

convert_web_url_to_txt

UrlToTextResponse convert_web_url_to_txt(input)

Convert website URL page to text (txt)

Converts a website URL page into text (txt); extracts text from HTML

Example

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'

# create an instance of the API class
api_instance = cloudmersive_convert_api_client.ConvertWebApi(cloudmersive_convert_api_client.ApiClient(configuration))
input = cloudmersive_convert_api_client.UrlToTextRequest() # UrlToTextRequest | HTML to Text request parameters

try:
    # Convert website URL page to text (txt)
    api_response = api_instance.convert_web_url_to_txt(input)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConvertWebApi->convert_web_url_to_txt: %s\n" % e)

Parameters

Name	Type	Description	Notes
input	UrlToTextRequest	HTML to Text request parameters

Return type

UrlToTextResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ConvertWebApi.md

Latest commit

History

ConvertWebApi.md

File metadata and controls

cloudmersive_convert_api_client.ConvertWebApi

convert_web_html_to_docx

Example

Parameters

Return type

Authorization

HTTP request headers

convert_web_html_to_pdf

Example

Parameters

Return type

Authorization

HTTP request headers

convert_web_html_to_png

Example

Parameters

Return type

Authorization

HTTP request headers

convert_web_html_to_txt

Example

Parameters

Return type

Authorization

HTTP request headers

convert_web_md_to_html

Example

Parameters

Return type

Authorization

HTTP request headers

convert_web_url_to_pdf

Example

Parameters

Return type

Authorization

HTTP request headers

convert_web_url_to_screenshot

Example

Parameters

Return type

Authorization

HTTP request headers

convert_web_url_to_txt

Example

Parameters

Return type

Authorization

HTTP request headers