Lint, coverage, waivers, reporting, certification, agent export, pipeline audit, toolsmith, context gate.
Lint an API artifact (FREE)
Lint an OpenAPI, AsyncAPI, Arazzo, or JSON Schema document against the curated 574-rule best-of-breed ruleset (Spectral). Pass your own Spectral ruleset to override the catalog.
Lint an API artifact (FREE) › Request Body
documentThe artifact as YAML or JSON text.
formatAuto-detected when omitted.
rulesetAn optional full Spectral ruleset definition to run instead of the catalog.
tagsOnly run catalog rules carrying one of these tags.
Lint an API artifact (FREE) › Responses
Lint result.
formatruleCountpassedGovernance coverage of a document (FREE)
How much of an API description the ruleset actually inspects — coverage by section, dead rules, and each rule reach.
Governance coverage of a document (FREE) › Request Body
documentThe API description (YAML or JSON text, or an object).
formatRule definitions to measure; defaults to the curated catalog for the format.
aliasesCustom JSONPath alias map.
Governance coverage of a document (FREE) › Responses
Coverage report.
Reconcile waivers against lint output (FREE)
Suppress sanctioned violations and surface expired, stale, and expiring waivers — the effective failing set your build should gate on.
Reconcile waivers against lint output (FREE) › Request Body
waiversA waivers file (YAML/JSON text) or an array of waiver objects.
Spectral lint -f json results.
Reconcile waivers against lint output (FREE) › Responses
Reconciliation result.
Render a governance report (FREE HTML, Pro SARIF)
Turn Spectral findings into a self-contained HTML governance report. Pass ?format=sarif for SARIF 2.1.0 output (Pro).
query Parameters
formatsarif requires a Pro key.
Render a governance report (FREE HTML, Pro SARIF) › Request Body
titletotalsPositive-rule sidecar for the compliance scoreboard.
darkRender a governance report (FREE HTML, Pro SARIF) › Responses
HTML report (text/html) or SARIF log (application/json with ?format=sarif).
Verify a governance certificate (FREE)
Re-verify a tamper-evident API governance certificate against the API it attests to. Consumer-facing trust check.
Verify a governance certificate (FREE) › Request Body
certificateapiThe API description object the certificate was issued over.
Verify a governance certificate (FREE) › Responses
Verdict.
verdictClassify PII and secret fields (FREE)
Inventory the PII, secret, and sensitive fields an OpenAPI exposes — across parameters and request/response schemas. Uses the same classifiers as Context Gate.
Classify PII and secret fields (FREE) › Request Body
documentA single OpenAPI (YAML/JSON text).
Classify PII and secret fields (FREE) › Responses
Sensitive-field inventory.
Detect breaking changes between two versions (FREE)
Compare two OpenAPI versions and classify every change as breaking, non-breaking, or an addition — at path, operation, parameter, request-body, and response granularity.
Detect breaking changes between two versions (FREE) › Request Body
oldThe previous OpenAPI (YAML/JSON text or object).
newThe new OpenAPI (YAML/JSON text or object).
Detect breaking changes between two versions (FREE) › Responses
Diff result with a compatible flag, summary, and changes[].
API maturity scorecard (FREE)
Roll up a 0-100 maturity score with a letter grade across dimensions — design/style (lint), governance coverage, documentation completeness, and (from an apis.json) discoverability, agent-readiness, and operations.
API maturity scorecard (FREE) › Request Body
documentAn OpenAPI (YAML/JSON text) for the lint/coverage/documentation dimensions.
apisJsonAn APIs.json for the discoverability/agent-readiness/operations dimensions.
formatAPI maturity scorecard (FREE) › Responses
Overall score, grade, and per-dimension breakdown.
Deprecation / sunset posture (FREE)
Report every deprecated operation and whether it announces a sunset (x-sunset date or a Sunset/Deprecation response header), plus deprecated schema fields — the honest migration picture.
Deprecation / sunset posture (FREE) › Request Body
documentAn OpenAPI (YAML/JSON text or object).
Deprecation / sunset posture (FREE) › Responses
Deprecated operations, sunset posture, and deprecated fields.
Generate example payloads (PRO)
Generate an example request and success-response payload for every operation from its OpenAPI schema (author example/default/enum first, else synthesized by type/format).
Generate example payloads (PRO) › Request Body
documentAn OpenAPI (YAML/JSON text or object).
operationIdOnly this operation.
pathOnly this path.
Generate example payloads (PRO) › Responses
Per-operation example request/response payloads.
Generate code samples (PRO)
Generate runnable curl / JavaScript (fetch) / Python (requests) samples for every operation, with path params filled in and a realistic request body.
Generate code samples (PRO) › Request Body
documentAn OpenAPI (YAML/JSON text or object).
baseUrlOverride the base URL (defaults to servers[0].url).
authHeaderAuth header to show, e.g. "Authorization: Bearer $TOKEN" or "x-api-key: $KEY".
operationIdOnly this operation.
pathOnly this path.
Generate code samples (PRO) › Responses
Per-operation curl/javascript/python snippets.
The curated rule catalog (FREE)
Browse the curated best-of-breed rule catalog the validator runs — every rule with its id, format, title, severity, tags, given, and reference. Optionally filter by artifact format.
query Parameters
formatOnly rules for this artifact format.
The curated rule catalog (FREE) › Responses
The rule catalog.
formatcountIssue a governance certificate (PRO)
Issue a tamper-evident certificate attesting an API description passed a named ruleset at a profile threshold. A SHA-256 fingerprint lets anyone re-verify it.
Issue a governance certificate (PRO) › Request Body
apiThe API description object.
The Spectral findings the certificate attests.
profileOne of the certification profiles (e.g. standard).
issuervalidMonthsIssue a governance certificate (PRO) › Responses
Certificate.
Export agent-native governance artifacts (PRO)
Turn a Spectral ruleset into an AGENTS.md governance block, a system-prompt instruction set, a per-rule remediation prompt pack, and a compact rule digest.
Export agent-native governance artifacts (PRO) › Request Body
rulesetA Spectral ruleset (with a rules object).
formatnameExport agent-native governance artifacts (PRO) › Responses
Agent-native artifacts.
Audit a repo Spectral CI maturity (PRO)
Score a repository Spectral governance pipeline against an 8-point maturity rubric and get a prioritized punch-list. Supply files inline, or a public repo (owner/name) to fetch.
Audit a repo Spectral CI maturity (PRO) › Request Body
repoGitHub repo as owner/name (public).
refBranch or SHA (default HEAD).
Audit a repo Spectral CI maturity (PRO) › Responses
Maturity score and punchlist.
Forge MCP tools and Agent Skills (PRO)
From an OpenAPI, forge an MCP server design, per-operation tools, Agent Skills, an enriched OpenAPI (x-mcp / x-agent-skills), a server.json, and apis.json properties.
Forge MCP tools and Agent Skills (PRO) › Request Body
documentThe OpenAPI as YAML or JSON text.
Forge MCP tools and Agent Skills (PRO) › Responses
Forged MCP and skills artifacts.
Emit a governed agent surface (PRO)
Choose which operations and fields your API exposes to agents; emit a governed Tyk OpenAPI, an MCP tool manifest, and a Spectral ruleset with PII/secret checks. Defaults to the whole surface when no selection is supplied.
Emit a governed agent surface (PRO) › Request Body
documentA single OpenAPI (YAML/JSON text).
selectionPer-operation selection (defaults to all selected).
Emit a governed agent surface (PRO) › Responses
Tyk OAS, MCP manifest, and ruleset.
Apply an OpenAPI Overlay (PRO)
Apply an OpenAPI Overlay (spec 1.0.0) to a document — each action resolves a target JSONPath and deep-merges update or removes the match. Returns the transformed OpenAPI plus a per-action report.
Apply an OpenAPI Overlay (PRO) › Request Body
documentThe OpenAPI to transform (YAML/JSON text or object).
overlayAn OpenAPI Overlay 1.0.0 document (YAML/JSON text or object).
Apply an OpenAPI Overlay (PRO) › Responses
Transformed OpenAPI and action report.
