Skip to content

Latest commit

 

History

History
240 lines (148 loc) · 9 KB

File metadata and controls

240 lines (148 loc) · 9 KB

\ConvertWebApi

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

Method HTTP request Description
ConvertWebHtmlToDocx Post /convert/html/to/docx Convert HTML to Word DOCX Document
ConvertWebHtmlToPdf Post /convert/web/html/to/pdf Convert HTML string to PDF
ConvertWebHtmlToPng Post /convert/web/html/to/png Convert HTML string to PNG screenshot
ConvertWebHtmlToTxt Post /convert/web/html/to/txt Convert HTML string to text (txt)
ConvertWebMdToHtml Post /convert/web/md/to/html Convert Markdown to HTML
ConvertWebUrlToPdf Post /convert/web/url/to/pdf Convert a URL to PDF
ConvertWebUrlToScreenshot Post /convert/web/url/to/screenshot Take screenshot of URL
ConvertWebUrlToTxt Post /convert/web/url/to/txt Convert website URL page to text (txt)

ConvertWebHtmlToDocx

string ConvertWebHtmlToDocx(ctx, inputRequest) Convert HTML to Word DOCX Document

Convert HTML to Office Word Document (DOCX) format

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
inputRequest HtmlToOfficeRequest HTML input to convert to DOCX

Return type

string

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]

ConvertWebHtmlToPdf

string ConvertWebHtmlToPdf(ctx, 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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
input HtmlToPdfRequest HTML to PDF request parameters

Return type

string

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]

ConvertWebHtmlToPng

string ConvertWebHtmlToPng(ctx, 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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
input HtmlToPngRequest HTML to PNG request parameters

Return type

string

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]

ConvertWebHtmlToTxt

HtmlToTextResponse ConvertWebHtmlToTxt(ctx, input) Convert HTML string to text (txt)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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]

ConvertWebMdToHtml

HtmlMdResult ConvertWebMdToHtml(ctx, inputFile) Convert Markdown to HTML

Convert a markdown file (.md) to HTML

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
inputFile *os.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]

ConvertWebUrlToPdf

string ConvertWebUrlToPdf(ctx, 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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
input UrlToPdfRequest URL to PDF request parameters

Return type

string

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]

ConvertWebUrlToScreenshot

string ConvertWebUrlToScreenshot(ctx, 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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
input ScreenshotRequest Screenshot request parameters

Return type

string

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]

ConvertWebUrlToTxt

UrlToTextResponse ConvertWebUrlToTxt(ctx, input) Convert website URL page to text (txt)

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
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]