This is the API v2 documentation. API v2 is currently in preview state and not recommended for production use! Read more about API v2 in our blog post.

Capture Websites

Create capture website tasks

Create a task to convert a website to PDF or to capture a screenshot of a website (png, jpg).

Arguments
url string, required The URL of the website.
output_format string, required The target format to convert to.
engine string, optional Use a specific engine for the conversion.
engine_version string, optional Use a specific engine version for the conversion.
filename string, optional Choose a filename (including extension) for the output file.
... optional Conversion and engine specific options. Depends on output_format.
Select the output format above to show additional conversion options.
{{ option.name }} optional, {{ option.type }} Defaults to {{ option.default }}. Possible values: , .

Returns

The created task. You can find details about the task model response in the documentation about the show tasks endpoint.

Endpoint

POST https://api.cloudconvert.com/v2/capture-website

Example Request

$ curl -X POST "https://api.cloudconvert.com/v2/capture-website" \
       -H "Authorization: Bearer API_KEY" \
       -H "Content-type: application/json" \
       -d '{
  "url": "https://www.google.com",
  "output_format": "pdf"
}'

Example Response

{
  "data": {
    "id": "c85f3ca9-164c-4e89-8ae2-c08192a7cb08",
    "operation": "capture-website",
    "status": "processing",
    "message": null,
    "created_at": "2018-09-19T14:42:58+00:00",
    "started_at": "2018-09-19T14:42:58+00:00",
    "ended_at": null,
    "depends_on_tasks": {},
    "engine": "chrome",
    "engine_version": "75",
    "payload": {
      "url": "https://www.google.com",
      "output_format": "pdf"
    },
    "result": null
  }
}