Web2Image REST API

The API for converting Web Pages to Images.

Sign In

Endpoints

POST http://do.convertapi.com/Web2Image

Authentication Parameters

Parameter Description Value
ApiKey

Required

Number

API Key should be passed if you purchased membership with credits. Please login to your control panel to find out your API Key http://www.convertapi.com/a

Input Parameters

Parameter Description Value
CUrl

Required

String

URI of a web page to convert. Must start with http:// or https://. Several URI of web pages merged with %20 (space) symbol can be passed to create one PDF. For example if http://www.google.com%20http://www.nytimes.com URI will be passed the two web pages will be merged into one PDF. If URI has special characters like ? or & they must be encoded. Also a HTML code can be submitted for conversion using this parameter.

Parameters

Parameter Description Value
PageWidth

Optional

Number

Set screen width.

PageHeight

Optional

Number

Set screen height. Default is calculated from page content.

Scripts

Optional

Boolean

Allow web pages to run javascript.

Default: true

Plugins

Optional

Boolean

Enable plugins such as flash.

Default: false

ConversionDelay

Optional

Number

Delay in seconds before page load and PDF creation. Sometimes usefull to let web page to load in full.

AuthUsername

Optional

String

HTTP authentication username, used if conversion web page is protected with HTTP authentication.

AuthPassword

Optional

String

HTTP Authentication password, used if conversion web page is protected with HTTP authentication.

UserAgent

Optional

String

Set custom user agent.

AcceptLanguage

Optional

String

Set accept language header.

AlternativeParser

Optional

Boolean

Set alternative parser. You should test both parsers and choose which to use depending on conversion quality.

Default: false

StoreFile

Optional

Boolean

Store file on server and return url to file instead of file stream response. File will be available for 24 hours.

Default: false

Timeout

Optional

Number

Conversion timeout in seconds.

Default: 300 (5 ... 600)

Output Headers

Output Response