Skip to main content

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

MicroSkills Reference

Validate XML Sitemap

web.validate_sitemap

ProductionBounded custom (Class B)Deterministicverifiablefastv1.0.0
File inputNo network

Overview

You send us sitemap markup and we read it through a streaming parser with document type definitions and external entities switched off, so a hostile file cannot reach anything. We tell you whether it is well-formed, whether the root is a urlset or a sitemapindex, how many entries it holds, whether every loc is an absolute http or https address, whether each lastmod is a real date, whether the sitemaps.org namespace is in place, and whether the entry count stays under the limit. No listed address is contacted and a sitemapindex is never followed to its children.

A sitemap that is wrong does not announce itself — indexing just quietly suffers, and finding out from a search console weeks later is an expensive way to learn about a mistyped date.

Reliability

The same markup and the same options always give the same verdict, and nothing leaves the platform. The parser reads the document in a stream with document type definitions and external entities disabled, so a file that tries to pull in a local path or an internal address gets nowhere. Anything not well-formed collapses to one clean state — valid false, type unknown, urlCount 0, and a single PARSE_ERROR — so a hostile document cannot be told apart from a merely broken one, and partial structure seen before the failure is discarded rather than reported. An invalid file is a normal successful answer, not a failure: read valid and errors. Only bad input stops the call, and retrying it unchanged will not help — sending neither xml nor fileRef, a maxUrls or maxUncompressedBytes outside its range, a file reference we cannot read for you, or markup larger than maxUncompressedBytes.

Context footprint

The reply holds only the verdict and the messages, never the markup, so it stays small even for a 50 MB sitemap — unless thousands of entries each earn an error. A successful call costs 1 execution credit.

When to use it

Whenever you are about to publish a sitemap, or want to know why one misbehaves. Use seo.validate_sitemap when you also need image, video, news, or hreflang extension checks.

When you need the listed pages fetched, or the child sitemaps walked.

Runs on Java's built-in streaming XML reader, configured to trust nothing.

Scope

Note
We check sitemap markup you already hold against the sitemap protocol.

Non-goals

  • Does not fetch any address the sitemap lists
  • Does not follow a sitemapindex to the sitemaps it points at
  • Does not submit the file to any search engine
  • Does not validate against the official XSD, only the protocol rules named here

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

parsingvalidation

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call1 credit

File handling

Accepts file_refProduces file_refMax input2 MBMax file size50 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 file50 MiBSkill and platform maximum

How we handle your data

Sensitive input, safe output
What this means

This skill may receive sensitive content, but it does not target sensitive data and returns only a structured non-sensitive result.

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 does not contain submitted 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
xmlstringNoBounded inline source. Required unless fileRef is provided.
fileRefstringNoTenant-scoped opaque file reference. Omit it when inline source is supplied.
validateUrlsbooleanNoWhether URL syntax and scheme are validated; omit it for true.
maxUrlsintegerNoURL validation cap; omit it for 50,000.
maxUncompressedBytesintegerNoUncompressed XML byte ceiling; omit it for the documented platform limit.

Output schema

FieldTypeRequiredDescription
validbooleanYesWhether no error-severity sitemap defect exists.
typestringYesParsed sitemap document type.
urlCountintegerYesParsed URL-entry count.
errorsarrayYesBounded array of sitemap validation error strings. The item shape is defined by the nested schema and the array contains from 0 through 20000 items.
warningsarrayYesBounded array of non-fatal sitemap warning strings. The item shape is defined by the nested schema and the array contains from 0 through 20000 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.validate_sitemap","input":{"xml":"<?xml version=\"1.0\"?><urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\"></urlset>"}}'
Integrations
TypeScript SDK
import { Squillify } from "@squillify/sdk";

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

const { output } = await sq.execute("web.validate_sitemap", {"xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\"><url><loc>https://example.com/</loc></url></urlset>"});

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 any address the sitemap lists
  • Does not follow a sitemapindex to the sitemaps it points at
  • Does not submit the file to any search engine
  • Does not validate against the official XSD, only the protocol rules named here
  • Fetching the pages or the child sitemaps the file points at
  • Finding out which pages a site has

How to call

POST /v1/execute (requires authentication)

Request bodyjson
{
  "skillKey": "web.validate_sitemap",
  "input": {
    "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\"><url><loc>https://example.com/</loc></url></urlset>"
  }
}

Examples

A clean sitemap with a single page

Inputjson
{
  "xml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\"><url><loc>https://example.com/</loc></url></urlset>"
}
Expected outputjson
{
  "warnings": [],
  "urlCount": 1,
  "valid": true,
  "type": "urlset",
  "errors": []
}

Markup that stops short and will not parse

Inputjson
{
  "xml": "<urlset><url><loc>oops"
}
Expected outputjson
{
  "warnings": [],
  "urlCount": 0,
  "valid": false,
  "type": "unknown",
  "errors": [
    "PARSE_ERROR: sitemap XML is not well-formed."
  ]
}
  • Block a broken sitemap from shipping, before a search engine sees it
  • Audit a sitemap you inherited and find out what is wrong with it
  • Verify what web.generate_sitemap produced as part of your build

Avoid for

  • Fetching the pages or the child sitemaps the file points at
  • Finding out which pages a site has

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

xmlwebseositemapvalidation