# Convert URL to Image — HTML to Image

> Capture a screenshot from a URL. See the documentation.

- Key: `html_to_image-convert-url-to-image`
- Type: Action (Write)
- Version: 0.0.2
- App: HTML to Image (`html_to_image`) — https://pipedream.com/apps/html-to-image.md
- This page (HTML): https://pipedream.com/apps/html-to-image/actions/convert-url-to-image
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/html_to_image/actions/convert-url-to-image/convert-url-to-image.mjs

## Description

Capture a screenshot from a URL. [See the documentation](https://docs.htmlcsstoimg.com/html-to-image-api/screenshot-capture-api).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `url` | `string` | Yes | The URL of the webpage |
| `viewPortWidth` | `integer` | No | Width of View Port. Default value is 1080 |
| `viewPortHeight` | `integer` | No | Height of View Port. Default value is 720 |
| `quality` | `integer` | No | Quality of the image should be in the range 30-100. Default value is 30. |
| `fullPage` | `boolean` | No | Whether to capture full-page screenshot of the URL. Default value is false. |
| `waitUntil` | `integer` | No | Number of seconds to wait before capturing a screenshot from the URL. Default value is 0 |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "html_to_image",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "html_to_image-convert-url-to-image",
  arguments: {
    url: "URL",
    viewPortWidth: 10,
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "html_to_image-convert-url-to-image",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    html_to_image: { authProvisionId: "apn_xxxxxxx" },
    url: "URL",
    viewPortWidth: 10,
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "html_to_image-convert-url-to-image",
    "configured_props": {
      "html_to_image": { "authProvisionId": "apn_xxxxxxx" },
      "url": "URL",
      "viewPortWidth": 10
    }
  }'
```

---

- App: https://pipedream.com/apps/html-to-image.md · All apps: https://pipedream.com/apps