Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions apps/docs/components/icons.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10459,3 +10459,16 @@ export function PlaneIcon(props: SVGProps<SVGSVGElement>) {
</svg>
)
}

/** CaptureKit logo, as used by the CaptureKit block. */
export function CaptureKitIcon(props: SVGProps<SVGSVGElement>) {
return (
<svg viewBox='-0.3 1.2 20.6 20.6' fill='none' xmlns='http://www.w3.org/2000/svg' {...props}>
<title>CaptureKit</title>
<path
d='M10.001 15.112C13.529 15.112 16.39 17.973 16.39 21.501H14.14C14.14 19.215 12.287 17.362 10.001 17.362C7.715 17.362 5.862 19.215 5.862 21.501H3.612C3.612 17.973 6.473 15.112 10.001 15.112ZM0 5.111C3.528 5.111 6.389 7.972 6.389 11.5C6.389 15.028 3.528 17.888 0 17.888V15.638C2.286 15.638 4.139 13.785 4.139 11.5C4.139 9.215 2.286 7.361 0 7.361V5.111ZM20.002 7.361C17.716 7.361 15.863 9.215 15.863 11.5C15.863 13.785 17.716 15.638 20.002 15.638V17.888C16.474 17.888 13.613 15.028 13.613 11.5C13.613 7.972 16.474 5.111 20.002 5.111V7.361ZM5.862 1.499C5.862 3.785 7.715 5.638 10.001 5.638C12.287 5.638 14.14 3.785 14.14 1.499H16.39C16.39 5.027 13.529 7.888 10.001 7.888C6.473 7.888 3.612 5.027 3.612 1.499H5.862Z'
fill='#7626FF'
/>
</svg>
)
}
2 changes: 2 additions & 0 deletions apps/docs/components/ui/icon-mapping.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ import {
BufferIcon,
CalComIcon,
CalendlyIcon,
CaptureKitIcon,
CbInsightsIcon,
ChartBarIcon,
CheckrIcon,
Expand Down Expand Up @@ -362,6 +363,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
buffer: BufferIcon,
calcom: CalComIcon,
calendly: CalendlyIcon,
capturekit: CaptureKitIcon,
cbinsights: CbInsightsIcon,
chat_trigger: Task,
checkr: CheckrIcon,
Expand Down
148 changes: 148 additions & 0 deletions apps/docs/content/docs/integrations/capturekit.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
---
title: CaptureKit
description: Capture screenshots and extract content from web pages
integration:
type: "capturekit"
color: "#FFFFFF"
---

import { ReferenceDetails } from "@/components/ui/reference-details"


{/* MANUAL-CONTENT-START:intro */}
[CaptureKit](https://www.capturekit.dev/) is a screenshot and web content API that runs the browsers for you.

With the CaptureKit block, you can:

- **Take screenshots**: capture a page as a PNG, JPEG, WebP image or a PDF, full page or by CSS selector, on 17+ emulated devices, without cookie banners and ads
- **Extract content**: get a page's title, metadata, internal, external and social links, and its Markdown
- **Fetch HTML**: get a page's raw HTML without a browser
- **Analyze websites**: get an AI summary of what a site offers, its audience, features and contact details

Create an API key in the [CaptureKit dashboard](https://app.capturekit.dev/) and paste it into the block.

In Sim, the CaptureKit block lets your agents archive pages for compliance, track competitor pages and turn websites into clean input for research.
{/* MANUAL-CONTENT-END */}

## Use the block [#usage-instructions]

Capture any web page as a PNG, JPEG, WebP image or a PDF, by viewport, full page or CSS selector on 17+ emulated devices; extract a page's metadata, links and Markdown; fetch raw HTML; and get an AI summary of what a website offers.

## Actions

### CaptureKit Take Screenshot

Capture a public web page as a PNG, JPEG, WebP image or a PDF, by viewport, full page or CSS selector, and store it as a file.

<ReferenceDetails>

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | Yes | URL of the page \(e.g., "https://example.com") |
| `format` | string | No | Output format: png, jpeg, webp or pdf \(defaults to "png"\) |
| `fullPage` | boolean | No | Capture the entire page instead of the visible viewport |
| `device` | string | No | Device to emulate \(e.g., "iphone_14_pro"\) |
| `selector` | string | No | CSS selector of one element to capture \(e.g., "#pricing"\) |
| `viewportWidth` | number | No | Width of the browser viewport in pixels \(defaults to 1280\) |
| `viewportHeight` | number | No | Height of the browser viewport in pixels \(defaults to 1024\) |
| `delay` | number | No | Seconds to wait before capturing \(defaults to 0\) |
| `removeCookieBanners` | boolean | No | Remove cookie banners before capturing |
| `removeAds` | boolean | No | Remove ads before capturing |
| `apiKey` | string | Yes | CaptureKit API key |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `file` | file | Screenshot or PDF of the page, stored in the execution files |

</ReferenceDetails>

### CaptureKit Extract Content

Render a web page and get its title, description, favicon, Open Graph image, internal, external and social links, and optionally its Markdown.

<ReferenceDetails>

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | Yes | URL of the page \(e.g., "https://example.com") |
| `includeMarkdown` | boolean | No | Include the page content as Markdown |
| `removeCookieBanners` | boolean | No | Remove cookie banners before capturing |
| `removeAds` | boolean | No | Remove ads before capturing |
| `apiKey` | string | Yes | CaptureKit API key |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `metadata` | object | Page metadata |
| ↳ `title` | string | Page title |
| ↳ `description` | string | Meta description |
| ↳ `favicon` | string | Favicon URL |
| ↳ `ogImage` | string | Open Graph image URL |
| `links` | object | Links found on the page |
| ↳ `internal` | array | Links to the same site |
| ↳ `external` | array | Links to other sites |
| ↳ `social` | array | Links to social profiles |
| `markdown` | string | Page content as Markdown, when requested |

</ReferenceDetails>

### CaptureKit Fetch HTML

Fetch the raw HTML of a public page over plain HTTP, without a browser.

<ReferenceDetails>

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | Yes | URL of the page, with http or https \(e.g., "https://example.com") |
| `apiKey` | string | Yes | CaptureKit API key |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `html` | string | Raw HTML of the page |

</ReferenceDetails>

### CaptureKit Analyze Website

Read a website and get an AI summary of its value proposition, business type, key features, categories, use cases, audience and contact details.

<ReferenceDetails>

#### Input

| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | Yes | URL of the page \(e.g., "https://example.com") |
| `customPrompt` | string | No | Extra instructions for the analysis \(e.g., "Focus on pricing"\) |
| `apiKey` | string | Yes | CaptureKit API key |

#### Output

| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `summary` | string | Summary of what the website offers |
| `valueProposition` | string | Value proposition of the website |
| `businessType` | string | Type of business |
| `targetAudience` | string | Audience the website addresses |
| `callToAction` | string | Main call to action of the website |
| `keyFeatures` | array | Key features of the product or service |
| `categories` | array | Categories of the website |
| `useCases` | array | Use cases the website describes |
| `emails` | array | Email addresses found on the website |
| `phoneNumbers` | array | Phone numbers found on the website |

</ReferenceDetails>


1 change: 1 addition & 0 deletions apps/docs/content/docs/integrations/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"calcom",
"calcom-service-account",
"calendly",
"capturekit",
"cbinsights",
"checkr",
"circleback",
Expand Down
Loading