Extract HTML Metadata
web.extract_html_metadata
Overview
You send HTML you already have and we read the head for you: title, meta description, canonical link, language, robots directive, every Open Graph and Twitter Card field, and the icon links. Give us a baseUrl and relative canonical and icon hrefs come back absolute. Nothing is fetched and no script runs, so what you get reflects the markup exactly as you sent it. Accepts file input via file_ref — no need to extract file content first.
Pulling head tags out with string matching breaks on real-world markup, and you would rather not render a whole page just to read six fields.
Reliability
Same markup and same options always give the same answer, and nothing leaves the platform. A few habits to expect: broken markup is repaired rather than rejected, so you get whatever survived; a repeated Open Graph or Twitter tag turns that key into an array instead of overwriting it; empty values are dropped rather than returned as empty strings; and sending both html and file_ref is accepted, with the file winning. Bad input is rejected outright and retrying will not help — sending neither html nor file_ref, a file reference we cannot read for you, or content beyond 2097152 bytes.
Context footprint
The reply is normally a few hundred bytes, but includeAllMeta returns every meta tag in the document, which on a heavily tagged page is much larger. A successful call costs 1 execution credit.
When to use it
When you hold some HTML and want its title, description, canonical, or social tags.
When the markup still needs fetching or rendering, or when the data you want lives in a structured-data block instead.
Runs on jsoup, the tolerant HTML parser that browsers' error recovery inspired.
Scope
Non-goals
- Does not fetch the page, its icons, or any other linked resource
- Does not render the page or run its scripts
- Does not check that a canonical URL or icon actually resolves
- Does not read metadata that only appears after JavaScript runs
Properties
Capabilities
Cost & billing
Flat rate per invocation
File handling
File limits
Constraints this skill applies to your input and generated files. The “Limited by” column shows the static source of each cap; none of these can be raised by upgrading your plan.
| Limit | Value | Limited by |
|---|---|---|
| Maximum size per input file | 2 MiB | Skill maximum |
How we handle your data
What this means
This skill may receive sensitive content and may return submitted, transformed, extracted, or reformatted content.
Squillify guarantees
- Runs inside Squillify
- This skill runs inside Squillify.
- Payloads are not sent to an external service by this skill.
- Squillify does not permanently store submitted payloads.
- Telemetry records metadata only, not submitted content.
- Submitted payloads are not used for training.
- Submitted payloads are not reviewed by humans.
- This skill does not target sensitive data.
- The response may contain submitted or transformed content.
Your responsibility
Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.
Input schema
| Field | Type | Required | Description |
|---|---|---|---|
| html | string | No | Bounded inline source. Required unless file_ref is provided. |
| file_ref | string | No | Tenant-scoped opaque file reference. Omit it when inline source is supplied. |
| baseUrl | string | No | Optional absolute base URL for relative metadata URLs; omit it to preserve relative values. |
| includeAllMeta | boolean | No | Whether every meta name/property pair is returned; omit it for false. |
| normalizeUrls | boolean | No | Whether metadata URLs are resolved and normalized; omit it for true. |
Output schema
| Field | Type | Required | Description |
|---|---|---|---|
| ok | boolean | Yes | Whether the HTML metadata was parsed successfully. |
| metadata | object | Yes | Closed metadata receipt with title, description, canonical, Open Graph, and optional all-meta properties. Its documented web receipt properties are bounded to 128 entries — unconstrained RFC 8259 JSON items. |
API contract
POST /v1/executecurl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"web.extract_html_metadata","input":{"html":"<html><head><title>Pricing</title></head></html>"}}'import { Squillify } from "@squillify/sdk";
const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });
const { output } = await sq.execute("web.extract_html_metadata", {"html":"<html lang=\"en\"><head><title>Pricing — Acme</title><meta name=\"description\" content=\"Plans and pricing for Acme.\"></head></html>"});Errors
| Code | HTTP | Retryable | Description |
|---|---|---|---|
| VALIDATION_ERROR | 400 | No | The request payload failed schema validation. |
| UNAUTHORIZED | 401 | No | Missing or invalid API key. |
| SKILL_NOT_ACCESSIBLE | 403 | No | The API key is not granted access to this skill. |
| SKILL_NOT_AVAILABLE_FOR_PLAN | 403 | No | This skill is not included in your current plan. |
| PLAN_ELIGIBILITY_UNAVAILABLE | 503 | Yes | Plan eligibility could not be decided. Retry after backoff. |
| SKILL_NOT_FOUND | 404 | No | The requested skill or version does not exist. |
| TENANT_RATE_LIMITED | 429 | Yes | Request rate limit exceeded. Retry after backoff. |
| QUOTA_EXCEEDED | 429 | Yes | Plan quota exhausted. Retryable once the quota period resets. |
| EXECUTION_TIMEOUT | 504 | Yes | Execution exceeded the allowed time budget. |
Other limits
| Limit | Value |
|---|---|
| Recommended inline bytes | 32 KiB |
Limitations
- Does not fetch the page, its icons, or any other linked resource
- Does not render the page or run its scripts
- Does not check that a canonical URL or icon actually resolves
- Does not read metadata that only appears after JavaScript runs
- Rendering a page or taking a screenshot of it
- Fetching a live page — bring the markup with you
- Reading structured data blocks, which web.extract_json_ld handles
How to call
POST /v1/execute (requires authentication)
{
"skillKey": "web.extract_html_metadata",
"input": {
"html": "<html lang=\"en\"><head><title>Pricing — Acme</title><meta name=\"description\" content=\"Plans and pricing for Acme.\"></head></html>"
}
}Examples
Title and description from a page head
{
"html": "<html lang=\"en\"><head><title>Pricing — Acme</title><meta name=\"description\" content=\"Plans and pricing for Acme.\"></head></html>"
}{
"metadata": {
"title": "Pricing — Acme",
"description": "Plans and pricing for Acme.",
"language": "en"
},
"ok": true
}Relative canonical resolved against a base URL
{
"baseUrl": "https://example.com",
"html": "<html><head><link rel=\"canonical\" href=\"/pricing\"><meta property=\"og:title\" content=\"Acme Pricing\"><meta property=\"og:type\" content=\"website\"></head></html>"
}{
"metadata": {
"canonical": "https://example.com/pricing",
"openGraph": {
"type": "website",
"title": "Acme Pricing"
}
},
"ok": true
}Recommended use cases
- Build a link preview or social card from HTML you saved
- Audit the title, description, and Open Graph tags before you publish
- Catalogue crawled pages by their declared metadata
Avoid for
- Rendering a page or taking a screenshot of it
- Fetching a live page — bring the markup with you
- Reading structured data blocks, which web.extract_json_ld handles
Related skills
Composable with
Safety & privacy
- Runs without calling any external service.
- Your payloads are never stored permanently.
- Telemetry captures metadata only — never your payload contents.
- We never train models on your payloads.
- No human reviews your payloads.