Extract Internal Links

seo.extract_internal_links

ProductionBounded custom (Class B)Deterministicstrictfastv1.0.0

File inputNo network

Overview

Classify HTML anchors as internal using a caller-declared site scope. 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.

Internal vs external is a scope question; this applies the scope you send, without a crawl.

Reliability

seo.extract_internal_links 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 plus a document URL and need in-scope links classified as internal.

When you want a site-wide graph — use seo.extract_internal_link_graph — or the HTML still needs fetching.

Scope

Note

Classify HTML anchors as internal using a caller-declared site 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 fetch link targets

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 input1 MBMax file size1 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.

Limit	Value	Limited by
Maximum size per input file	1 MiB	Skill 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

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	Yes	Required. Absolute page URL used as the document origin.
siteScope	string	No	origin, host, or registrable-domain. Omit it and we use origin.
includeNonHttp	boolean	No	When true, keep non-http hrefs. Omit it and we drop them.

Output schema

Field	Type	Required	Description
links	array	Yes	Required. Structured 'links' value. Objects expose named properties; arrays list bounded rows or strings produced from the supplied artifacts, up to 10,000 entries.
uniqueUrls	array	Yes	Required. Structured 'uniqueUrls' value. Objects expose named properties; arrays list bounded rows or strings produced from the supplied artifacts, up to 10,000 entries.
uniqueDomains	array	Yes	Required. Structured 'uniqueDomains' 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.
uniqueCount	integer	Yes	Required. Structured 'uniqueCount' value produced by this offline analysis.
siteScope	string	Yes	Required. Structured 'siteScope' value produced by this offline analysis.
includeNonHttp	boolean	Yes	Required. Structured 'includeNonHttp' value produced by this offline analysis.

API contract

POST /v1/execute

curl

curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"seo.extract_internal_links","input":{"html":"<html><body><a href=\"/blog\">Blog</a></body></html>","documentUrl":"https://www.example.com/pricing"}}'

Integrations

TypeScript SDK

import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("seo.extract_internal_links", {"documentUrl":"https://www.example.com/pricing","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>","siteScope":"origin"});

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 fetch link targets
Fetching the live page
Checking which links return 404

How to call

POST /v1/execute (requires authentication)

Request bodyjson

{
  "skillKey": "seo.extract_internal_links",
  "input": {
    "documentUrl": "https://www.example.com/pricing",
    "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>",
    "siteScope": "origin"
  }
}

Examples

Primary business path

Inputjson

{
  "documentUrl": "https://www.example.com/pricing",
  "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>",
  "siteScope": "origin"
}

Expected outputjson

{
  "siteScope": "origin",
  "uniqueUrls": [
    "https://www.example.com/blog",
    "https://www.example.com/pricing"
  ],
  "count": 2,
  "links": [
    {
      "url": "/blog",
      "normalizedUrl": "https://www.example.com/blog",
      "text": "Blog",
      "rel": "",
      "source": "anchor",
      "internal": true
    },
    {
      "url": "https://www.example.com/pricing",
      "normalizedUrl": "https://www.example.com/pricing",
      "text": "",
      "rel": "canonical",
      "source": "link",
      "internal": true
    }
  ],
  "uniqueDomains": [
    "www.example.com"
  ],
  "uniqueCount": 2,
  "includeNonHttp": false
}

Tip

First realistic scenario for this skill.

Boundary or option path