Extract Open Graph
seo.extract_open_graph
Overview
Collect og property declarations from supplied HTML without fetching images. We never fetch a URL, run a script, or choose a winner. A successful call costs 1 execution credit. Accepts file input via file_ref — no need to extract file content first.
Social tags are easy to miss in a head dump; this extracts only the og properties.
Reliability
seo.extract_open_graph is stable for identical input. Identical input always produces identical JSON. SEO_INPUT_REQUIRED means a required field is missing or has the wrong shape, so send the published object rather than a guessed map; retrying unchanged will not help. SEO_INPUT_TOO_LARGE means a value exceeds its ceiling, so trim it. SEO_HTML_MALFORMED means the HTML could not be parsed under the offline HTML contract, so fix the markup. SEO_XML_MALFORMED means the XML is not well-formed, so correct it. SEO_XML_DOCTYPE_NOT_ALLOWED means the XML includes a DOCTYPE declaration, so strip the DOCTYPE and resend; we refuse DTDs rather than expanding entities. SEO_JSONLD_MALFORMED means a JSON-LD block is not usable JSON, so correct it. SEO_PROFILE_UNKNOWN means the named profile is not bundled, so send one of the published profile ids. SEO_TOO_MANY_RECORDS means a list exceeded its ceiling, so split the batch. SEO_GRAPH_LIMIT_EXCEEDED means the graph exceeded its node or edge ceiling, so shrink it. SEO_INVALID_URL means a URL string is not a usable RFC 3986 URI, so send an absolute URI. SEO_OBSERVATION_INCOMPLETE means required observation coverage is missing, so add the missing evidence. SEO_INPUT_CONFLICT means two fields that cannot be used together were both supplied, so drop one. Retrying an unchanged request will not help.
Context footprint
Returns a compact structured record. A successful call costs 1 execution credit.
When to use it
When you already hold HTML and need og:* properties as a structured map.
When you want Twitter card tags — use seo.extract_twitter_cards — or the HTML still needs fetching.
Scope
Non-goals
- Does not fetch a URL, resolve DNS, or run a browser
- Does not predict ranking, choose a winner, or claim live index status
- Does not render a share preview
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 | 1 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 | HTML to parse. Required unless file_ref is sent. |
| file_ref | string | No | Tenant-scoped file reference. Omit it when html is sent. |
| documentUrl | string | No | Absolute page URL used as the base. Omit it to keep relative values. |
Output schema
| Field | Type | Required | Description |
|---|---|---|---|
| documentUrl | string | Yes | Required. Structured 'documentUrl' value produced by this offline analysis. |
| syntax | string | Yes | Required. Structured 'syntax' value produced by this offline analysis. |
| properties | object | Yes | Required. Structured 'properties' value. Objects expose named properties; arrays list bounded rows or strings produced from the supplied artifacts, up to 10,000 entries. |
| declarations | array | Yes | Required. Structured 'declarations' value. Objects expose named properties; arrays list bounded rows or strings produced from the supplied artifacts, up to 10,000 entries. |
| duplicates | array | Yes | Required. Structured 'duplicates' value. Objects expose named properties; arrays list bounded rows or strings produced from the supplied artifacts, up to 10,000 entries. |
| count | integer | Yes | Required. Structured 'count' value produced by this offline analysis. |
API contract
POST /v1/executecurl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"seo.extract_open_graph","input":{"html":"<html><head><title>Acme</title></head><body><h1>Hi</h1></body></html>"}}'import { Squillify } from "@squillify/sdk";
const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });
const { output } = await sq.execute("seo.extract_open_graph", {"html":"<html><head><title>Acme Pricing</title><meta name=\"description\" content=\"Plans and pricing for Acme Cloud.\"><meta property=\"og:title\" content=\"Acme Pricing\"><meta name=\"twitter:card\" content=\"summary\"><link rel=\"canonical\" href=\"https://www.example.com/pricing\"></head><body><h1>Pricing</h1><h2>Plans</h2><a href=\"/blog\">Blog</a><a href=\"https://partner.example.net/x\">Partner</a><p>Acme Cloud pricing for teams.</p></body></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. |
| SEO_INPUT_REQUIRED | 400 | No | The request payload failed this skill's input validation. |
| SEO_INPUT_TOO_LARGE | 429 | No | A size, quota, rate, or time limit was exceeded. |
| SEO_HTML_MALFORMED | 400 | No | The request payload failed this skill's input validation. |
| SEO_PROFILE_UNKNOWN | 400 | No | The request payload failed this skill's input validation. |
| SEO_TOO_MANY_RECORDS | 429 | No | A size, quota, rate, or time limit was exceeded. |
Other limits
| Limit | Value |
|---|---|
| Recommended inline bytes | 32 KiB |
Limitations
- Does not fetch a URL, resolve DNS, or run a browser
- Does not predict ranking, choose a winner, or claim live index status
- Does not render a share preview
- Creating Open Graph tags
- Previewing the Facebook share card
How to call
POST /v1/execute (requires authentication)
{
"skillKey": "seo.extract_open_graph",
"input": {
"html": "<html><head><title>Acme Pricing</title><meta name=\"description\" content=\"Plans and pricing for Acme Cloud.\"><meta property=\"og:title\" content=\"Acme Pricing\"><meta name=\"twitter:card\" content=\"summary\"><link rel=\"canonical\" href=\"https://www.example.com/pricing\"></head><body><h1>Pricing</h1><h2>Plans</h2><a href=\"/blog\">Blog</a><a href=\"https://partner.example.net/x\">Partner</a><p>Acme Cloud pricing for teams.</p></body></html>"
}
}Examples
Primary business path
{
"html": "<html><head><title>Acme Pricing</title><meta name=\"description\" content=\"Plans and pricing for Acme Cloud.\"><meta property=\"og:title\" content=\"Acme Pricing\"><meta name=\"twitter:card\" content=\"summary\"><link rel=\"canonical\" href=\"https://www.example.com/pricing\"></head><body><h1>Pricing</h1><h2>Plans</h2><a href=\"/blog\">Blog</a><a href=\"https://partner.example.net/x\">Partner</a><p>Acme Cloud pricing for teams.</p></body></html>"
}{
"count": 1,
"duplicates": [],
"properties": {
"og:title": "Acme Pricing"
},
"declarations": [
{
"line": 1,
"column": 109,
"pos": 108,
"property": "og:title",
"content": "Acme Pricing"
}
],
"syntax": "openGraph",
"documentUrl": ""
}Boundary or option path
{
"html": "<html><head><title>Acme Pricing</title><meta name=\"description\" content=\"Plans and pricing for Acme Cloud.\"><meta property=\"og:title\" content=\"Acme Pricing\"><meta name=\"twitter:card\" content=\"summary\"><link rel=\"canonical\" href=\"https://www.example.com/pricing\"></head><body><h1>Pricing</h1><h2>Plans</h2><a href=\"/blog\">Blog</a><a href=\"https://partner.example.net/x\">Partner</a><p>Acme Cloud pricing for teams.</p></body></html>",
"documentUrl": "https://www.example.com/pricing"
}{
"count": 1,
"duplicates": [],
"properties": {
"og:title": "Acme Pricing"
},
"declarations": [
{
"line": 1,
"column": 109,
"pos": 108,
"property": "og:title",
"content": "Acme Pricing"
}
],
"syntax": "openGraph",
"documentUrl": "https://www.example.com/pricing"
}Recommended use cases
- Confirm og:title matches the HTML title
- Feed og:url into a later canonical check
Avoid for
- Creating Open Graph tags
- Previewing the Facebook share card
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.