Content API
The Content API allows you to extract structured data from any webpage, including metadata, links, and raw HTML.
Endpoint
https://api.capturekit.dev/content
Example Request
GET https://api.capturekit.dev/content?access_key=<your-access-key>&url=https://tailwindcss.com
Response
{
"success": true,
"data": {
"metadata": {
"title": "Tailwind CSS - Rapidly build modern websites without ever leaving your HTML.",
"description": "Tailwind CSS is a utility-first CSS framework.",
"favicon": "https://tailwindcss.com/favicons/favicon-32x32.png",
"ogImage": "https://tailwindcss.com/opengraph-image.jpg"
},
"links": {
"internal": ["https://tailwindcss.com/", "https://tailwindcss.com/docs"],
"external": ["https://tailwindui.com", "https://shopify.com"],
"social": [
"https://github.com/tailwindlabs/tailwindcss",
"https://x.com/tailwindcss"
]
},
"html": "<html><body><h1>Hello, world!</h1></body></html>"
}
}
Parameters
url
string Required
The URL of the webpage to capture.
access_key
string Required
Your API access key. Can be provided via the access_key
query parameter, x-access-key
header, or request body.
include_html
boolean Optional Defaults to false
Include the raw HTML of the webpage in the response.
delay
number Optional Defaults to 0
Delay in seconds before capturing the screenshot (max 10s
).
wait_until
string Optional
Define when to capture (networkidle2
, load
, domcontentloaded
, networkidle0
).
wait_for_selector
string Optional
Wait for a specific element to appear before taking the screenshot.
selector
string Optional
Capture a specific element on the page instead of the full viewport.
remove_selectors
string Optional
A comma-separated list of elements to hide before capturing (e.g., ads, popups).
cache
boolean Optional Defaults to false
Cache the response.
cache_ttl
number Optional Defaults to 2592000
Cache the response for a custom TTL (in seconds). Maximum 2592000
seconds (1 month), minimum 3600
seconds (1 hour).
remove_cookie_banners
boolean Optional Defaults to false
Automatically remove cookie banners before capturing.
viewport_width
number Optional Defaults to 1280
The width of the browser viewport in pixels.
viewport_height
number Optional Defaults to 1024
The height of the browser viewport in pixels.