Skip to main content

Squillify development is paused indefinitely. Read why, and discover what this experiment achieved. Read the story

MicroSkills Reference

Extract HTML Metadata

web.extract_html_metadata

ProductionEngine wrapper (Class A)Deterministicverifiablefastv1.0.0
File inputNo network

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

Note
We read page metadata out of HTML you already hold, without rendering it or fetching anything.

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

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

analysisparsing

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call1 credit

File handling

Accepts file_refProduces file_refMax input2 MBMax file size2 MB

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.

LimitValueLimited by
Maximum size per input file2 MiBSkill maximum

How we handle your data

Sensitive output possible
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.

Read the Microskill Data Handling Policy

Input schema

FieldTypeRequiredDescription
htmlstringNoBounded inline source. Required unless file_ref is provided.
file_refstringNoTenant-scoped opaque file reference. Omit it when inline source is supplied.
baseUrlstringNoOptional absolute base URL for relative metadata URLs; omit it to preserve relative values.
includeAllMetabooleanNoWhether every meta name/property pair is returned; omit it for false.
normalizeUrlsbooleanNoWhether metadata URLs are resolved and normalized; omit it for true.

Output schema

FieldTypeRequiredDescription
okbooleanYesWhether the HTML metadata was parsed successfully.
metadataobjectYesClosed 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/execute
curl
curl -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>"}}'
Integrations
TypeScript SDK
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

CodeHTTPRetryableDescription
VALIDATION_ERROR400NoThe request payload failed schema validation.
UNAUTHORIZED401NoMissing or invalid API key.
SKILL_NOT_ACCESSIBLE403NoThe API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN403NoThis skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE503YesPlan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND404NoThe requested skill or version does not exist.
TENANT_RATE_LIMITED429YesRequest rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED429YesPlan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT504YesExecution exceeded the allowed time budget.

Other limits

LimitValue
Recommended inline bytes32 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)

Request bodyjson
{
  "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

Inputjson
{
  "html": "<html lang=\"en\"><head><title>Pricing — Acme</title><meta name=\"description\" content=\"Plans and pricing for Acme.\"></head></html>"
}
Expected outputjson
{
  "metadata": {
    "title": "Pricing — Acme",
    "description": "Plans and pricing for Acme.",
    "language": "en"
  },
  "ok": true
}

Relative canonical resolved against a base URL

Inputjson
{
  "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>"
}
Expected outputjson
{
  "metadata": {
    "canonical": "https://example.com/pricing",
    "openGraph": {
      "type": "website",
      "title": "Acme Pricing"
    }
  },
  "ok": true
}
  • 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

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.

Tags

seometadataweb