Getting Started

Welcome to CaptureKit! This guide will walk you through setting up and making your first API request. In just a few minutes, you’ll be able to capture screenshots, extract structured content, and analyze webpages using our API.

1. Get Your Access Key 🔑

To start using CaptureKit, you’ll need an Access Token. Follow these steps:

Sign up at CaptureKit Dashboard
Copy your Access Key from the project Access Keys tab.

You can attach your access key to requests in any of these ways:

GET parameter: access_key
POST parameter: access_key
Header: x-access-key

2. Make Your First API Request

Note: You can make requests using either GET or POST methods.

Screenshot API

GET https://api.capturekit.dev/capture?access_key=<your-access-key>&url=https://tailwindcss.com

Response

Screenshot Example

Content API

GET https://api.capturekit.dev/content?access_key=<your-access-key>&url=https://capturekit.dev

Response

{
	"success": true,
	"data": {
		"metadata": {
			"title": "CaptureKit - Turn any website into a screenshot with our powerful Screenshot API",
			"description": "CaptureKit is a powerful API for capturing screenshots, extracting HTML, gathering links, and summarizing content—all with a simple request.",
			"favicon": "https://capturekit.dev/favicon.ico",
			"ogImage": "https://capturekit-assets.s3.amazonaws.com/capturekit-og+(1).png"
		},
		"links": {
			"internal": [
				"https://capturekit.dev/",
				"https://capturekit.dev/dashboard",
				"https://capturekit.dev/pricing",
				"https://capturekit.dev/blog"
			],
			"external": [
				"https://docs.capturekit.dev",
				"https://zapier.com/apps/capturekit-website-screenshots-p/integrations",
				"https://www.nextupkit.com"
			],
			"social": [
				"https://github.com/CaptureKit-Web-Scraping-API",
				"https://x.com/capturekit"
			]
		},
		"html": "<html><body><h1>Hello, world!</h1></body></html>",
		"markdown": "CaptureKit - Turn any website into a screenshot with our powerful Screenshot API...",
		"sitemap": {
			"source": "https://capturekit.dev/sitemap.xml",
			"totalLinks": 3,
			"links": [
				"https://www.capturekit.dev/",
				"https://www.capturekit.dev/page-content"
				"https://www.capturekit.dev/ai"
			]
		}
	}
}

AI Content Analysis API

GET https://api.capturekit.dev/analyze?access_key=<your-access-key>&url=https://tailwindcss.com

Response

{
	"success": true,
	"data": {
		"summary": "Tailwind CSS is a utility-first CSS framework for modern web design.",
		"valueProposition": "A flexible CSS framework packed with utility classes.",
		"keyFeatures": [
			"Responsive design",
			"Dark mode",
			"Animations",
			"Grid layout"
		],
		"useCases": [
			"Building websites",
			"Customizing themes",
			"Managing CSS specificity"
		],
		"targetAudience": "Web developers and designers."
	}
}

Introduction Authentication