Full OpenAPI3.1 schema · Input and output JSON schemas · Usage documentation
Anonymous public reads. GET query parameters or POST JSON; both invoke the same read-only operation.
The complete public GradientDeck UI reference library: original compact and extended Markdown, metadata, palettes, typefaces, component/design rules, Agent Prompt Guide and Quick Start instructions. No WHOX account or API key is required. These are design references for your own interfaces; original designs belong to the referenced sites. Source attribution and SHA-256 hashes are preserved. Media links are returned but media/font files and usage licenses are not bundled.
Workflow: GET /v1/filters, search /v1/search?q=fintech&theme=dark, then fetch /v1/design?slug=hifi&variant=both or /v1/instructions?slug=hifi. Search metadata by default; content=true also searches both full Markdown documents. Pagination uses nextOffset until null; no rows are silently truncated. /v1/export returns up to 20 designs per JSON page and may return fewer to stay within the 2MiB bound; always follow nextOffset.
Direct files: /designs/{slug}/design.md and /designs/{slug}/design-extended.md. Full metadata: /library.json. All source Markdown and metadata in one downloadable ZIP: /archive.zip. See /v1/stats for current counts, completeness, retrieval time and snapshot ID.
Reads are served immediately from a complete validated local snapshot. The source index is checked every six hours. New/changed entries are fetched then; all Markdown is revalidated at least daily when the source is reachable. A failed refresh retains the previous complete snapshot, and every response exposes its actual mirroredAt/ageMs. No browser, login, private sessions or source writes are involved. The 2MiB JSON response limit remains; the static ZIP download has its own 128MiB cap. Fair use is 60 requests/minute/IP. api.json declares this native snapshot adapter; use openapi.json as the portable HTTP client schema.Search and filter every design in the complete source library; returns metadata and original Markdown URLs.
GET https://gradientdeck.api.whox.ai/v1/search
| Argument | Type | Required | Description |
|---|---|---|---|
| q | string | No | Case-insensitive AND search across site metadata; set content=true to also search both complete Markdown files. |
| theme | string | No | Exact theme. |
| industry | string | No | Exact industry code from filters. |
| font | string | No | Case-insensitive font-name substring. |
| color | string | No | Exact palette hex color. URL-encode # as %23. |
| content | boolean | No | Include full Markdown in q search; default false. |
| sort | string | No | Newest follows source library order; name sorts by title. |
| offset | number | No | Zero-based offset. |
| limit | number | No | Results per page. |
{
"type": "object",
"required": [
"ok",
"service",
"operation",
"data",
"meta"
],
"properties": {
"ok": {
"const": true
},
"service": {
"type": "string"
},
"operation": {
"type": "string"
},
"data": {
"type": "object",
"required": [
"total",
"offset",
"limit",
"returned",
"nextOffset",
"results"
],
"properties": {
"total": {
"type": "integer",
"minimum": 0
},
"offset": {
"type": "integer",
"minimum": 0
},
"limit": {
"type": "integer",
"minimum": 0
},
"returned": {
"type": "integer",
"minimum": 0
},
"nextOffset": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"slug",
"name",
"nickname",
"industry",
"theme",
"host",
"colors",
"fonts",
"sourceUrl",
"documents",
"apiUrl"
],
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"nickname": {
"type": "string"
},
"industry": {
"type": "string"
},
"theme": {
"enum": [
"light",
"dark",
"mixed"
]
},
"host": {
"type": "string"
},
"cover_asset": {
"type": [
"object",
"null"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"alt": {
"type": "string"
},
"width": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"height": {
"type": [
"integer",
"null"
],
"minimum": 0
}
},
"additionalProperties": true
},
"video": {
"type": [
"string",
"null"
]
},
"icon": {
"type": [
"object",
"null"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"dark": {
"type": "boolean"
}
},
"additionalProperties": true
},
"tone": {
"type": "object",
"properties": {
"bg": {
"type": "string"
},
"ink": {
"type": "string"
}
}
},
"colors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"hex"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"hex": {
"type": "string"
}
},
"additionalProperties": true
}
},
"fonts": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"type": "string",
"format": "uri"
},
"documents": {
"type": "object",
"properties": {
"compact": {
"type": "string",
"format": "uri"
},
"extended": {
"type": "string",
"format": "uri"
}
}
},
"apiUrl": {
"type": "string",
"format": "uri"
},
"content": {
"type": "object",
"properties": {
"compact": {
"type": "object",
"required": [
"variant",
"markdown",
"sections",
"url",
"sha256",
"bytes",
"fetchedAt"
],
"properties": {
"retrievalUrl": {
"type": "string",
"format": "uri"
},
"retrievalMethod": {
"enum": [
"direct-markdown",
"public-page-export"
]
},
"variant": {
"enum": [
"compact",
"extended"
]
},
"markdown": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"heading",
"markdown"
],
"properties": {
"id": {
"type": "string"
},
"heading": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"additionalProperties": false
}
},
"url": {
"type": "string",
"format": "uri"
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"fetchedAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"extended": {
"type": "object",
"required": [
"variant",
"markdown",
"sections",
"url",
"sha256",
"bytes",
"fetchedAt"
],
"properties": {
"retrievalUrl": {
"type": "string",
"format": "uri"
},
"retrievalMethod": {
"enum": [
"direct-markdown",
"public-page-export"
]
},
"variant": {
"enum": [
"compact",
"extended"
]
},
"markdown": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"heading",
"markdown"
],
"properties": {
"id": {
"type": "string"
},
"heading": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"additionalProperties": false
}
},
"url": {
"type": "string",
"format": "uri"
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"fetchedAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"required": [
"tier",
"source",
"durationMs",
"cached"
],
"properties": {
"tier": {
"const": 1
},
"source": {
"type": "string",
"format": "uri"
},
"durationMs": {
"type": "number"
},
"cached": {
"type": "boolean"
},
"ageMs": {
"type": "number"
},
"definitionVersion": {
"type": "string"
},
"snapshot": {
"type": "string"
},
"mirroredAt": {
"type": "string",
"format": "date-time"
},
"complete": {
"type": "boolean"
},
"sourceWarnings": {
"type": "array",
"description": "Source records that do not establish a requested capacity minimum; not verified matches.",
"items": {
"type": "object"
}
}
}
}
},
"additionalProperties": false
}Get all metadata and full, unmodified compact/extended design Markdown, sections and provenance.
GET https://gradientdeck.api.whox.ai/v1/design
| Argument | Type | Required | Description |
|---|---|---|---|
| slug | string | Yes | Exact slug returned by search; never a URL or filesystem path. |
| variant | string | No | Which original source Markdown to return. |
{
"type": "object",
"required": [
"ok",
"service",
"operation",
"data",
"meta"
],
"properties": {
"ok": {
"const": true
},
"service": {
"type": "string"
},
"operation": {
"type": "string"
},
"data": {
"type": "object",
"required": [
"slug",
"name",
"nickname",
"industry",
"theme",
"host",
"colors",
"fonts",
"sourceUrl",
"documents",
"apiUrl"
],
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"nickname": {
"type": "string"
},
"industry": {
"type": "string"
},
"theme": {
"enum": [
"light",
"dark",
"mixed"
]
},
"host": {
"type": "string"
},
"cover_asset": {
"type": [
"object",
"null"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"alt": {
"type": "string"
},
"width": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"height": {
"type": [
"integer",
"null"
],
"minimum": 0
}
},
"additionalProperties": true
},
"video": {
"type": [
"string",
"null"
]
},
"icon": {
"type": [
"object",
"null"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"dark": {
"type": "boolean"
}
},
"additionalProperties": true
},
"tone": {
"type": "object",
"properties": {
"bg": {
"type": "string"
},
"ink": {
"type": "string"
}
}
},
"colors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"hex"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"hex": {
"type": "string"
}
},
"additionalProperties": true
}
},
"fonts": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"type": "string",
"format": "uri"
},
"documents": {
"type": "object",
"properties": {
"compact": {
"type": "string",
"format": "uri"
},
"extended": {
"type": "string",
"format": "uri"
}
}
},
"apiUrl": {
"type": "string",
"format": "uri"
},
"content": {
"type": "object",
"properties": {
"compact": {
"type": "object",
"required": [
"variant",
"markdown",
"sections",
"url",
"sha256",
"bytes",
"fetchedAt"
],
"properties": {
"retrievalUrl": {
"type": "string",
"format": "uri"
},
"retrievalMethod": {
"enum": [
"direct-markdown",
"public-page-export"
]
},
"variant": {
"enum": [
"compact",
"extended"
]
},
"markdown": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"heading",
"markdown"
],
"properties": {
"id": {
"type": "string"
},
"heading": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"additionalProperties": false
}
},
"url": {
"type": "string",
"format": "uri"
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"fetchedAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"extended": {
"type": "object",
"required": [
"variant",
"markdown",
"sections",
"url",
"sha256",
"bytes",
"fetchedAt"
],
"properties": {
"retrievalUrl": {
"type": "string",
"format": "uri"
},
"retrievalMethod": {
"enum": [
"direct-markdown",
"public-page-export"
]
},
"variant": {
"enum": [
"compact",
"extended"
]
},
"markdown": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"heading",
"markdown"
],
"properties": {
"id": {
"type": "string"
},
"heading": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"additionalProperties": false
}
},
"url": {
"type": "string",
"format": "uri"
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"fetchedAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
},
"meta": {
"type": "object",
"required": [
"tier",
"source",
"durationMs",
"cached"
],
"properties": {
"tier": {
"const": 1
},
"source": {
"type": "string",
"format": "uri"
},
"durationMs": {
"type": "number"
},
"cached": {
"type": "boolean"
},
"ageMs": {
"type": "number"
},
"definitionVersion": {
"type": "string"
},
"snapshot": {
"type": "string"
},
"mirroredAt": {
"type": "string",
"format": "date-time"
},
"complete": {
"type": "boolean"
},
"sourceWarnings": {
"type": "array",
"description": "Source records that do not establish a requested capacity minimum; not verified matches.",
"items": {
"type": "object"
}
}
}
}
},
"additionalProperties": false
}Get complete design instructions with extracted Agent Prompt Guide, Quick Start, rules and all original sections.
GET https://gradientdeck.api.whox.ai/v1/instructions
| Argument | Type | Required | Description |
|---|---|---|---|
| slug | string | Yes | Exact slug returned by search; never a URL or filesystem path. |
| variant | string | No | Which original source Markdown to return. |
{
"type": "object",
"required": [
"ok",
"service",
"operation",
"data",
"meta"
],
"properties": {
"ok": {
"const": true
},
"service": {
"type": "string"
},
"operation": {
"type": "string"
},
"data": {
"type": "object",
"required": [
"slug",
"name",
"variant",
"sourceUrl",
"sha256",
"fetchedAt",
"agentPromptGuide",
"quickStart",
"rules",
"sections",
"markdown"
],
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"variant": {
"enum": [
"compact",
"extended"
]
},
"sourceUrl": {
"type": "string",
"format": "uri"
},
"retrievalUrl": {
"type": "string",
"format": "uri"
},
"retrievalMethod": {
"enum": [
"direct-markdown",
"public-page-export"
]
},
"sha256": {
"type": "string"
},
"fetchedAt": {
"type": "string",
"format": "date-time"
},
"agentPromptGuide": {
"type": [
"string",
"null"
]
},
"quickStart": {
"type": [
"string",
"null"
]
},
"rules": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"heading",
"markdown"
],
"properties": {
"id": {
"type": "string"
},
"heading": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"additionalProperties": false
}
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"heading",
"markdown"
],
"properties": {
"id": {
"type": "string"
},
"heading": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"additionalProperties": false
}
},
"markdown": {
"type": "string"
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"required": [
"tier",
"source",
"durationMs",
"cached"
],
"properties": {
"tier": {
"const": 1
},
"source": {
"type": "string",
"format": "uri"
},
"durationMs": {
"type": "number"
},
"cached": {
"type": "boolean"
},
"ageMs": {
"type": "number"
},
"definitionVersion": {
"type": "string"
},
"snapshot": {
"type": "string"
},
"mirroredAt": {
"type": "string",
"format": "date-time"
},
"complete": {
"type": "boolean"
},
"sourceWarnings": {
"type": "array",
"description": "Source records that do not establish a requested capacity minimum; not verified matches.",
"items": {
"type": "object"
}
}
}
}
},
"additionalProperties": false
}Get every source theme, industry, font and palette color with exact design counts.
GET https://gradientdeck.api.whox.ai/v1/filters
| Argument | Type | Required | Description |
|---|
{
"type": "object",
"required": [
"ok",
"service",
"operation",
"data",
"meta"
],
"properties": {
"ok": {
"const": true
},
"service": {
"type": "string"
},
"operation": {
"type": "string"
},
"data": {
"type": "object",
"required": [
"themes",
"industries",
"fonts",
"colors",
"sorts",
"sourceOrder"
],
"properties": {
"themes": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"count"
],
"properties": {
"value": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
},
"industries": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"count"
],
"properties": {
"value": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
},
"fonts": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"count"
],
"properties": {
"value": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
},
"colors": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"count"
],
"properties": {
"value": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
},
"sorts": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceOrder": {
"type": "string"
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"required": [
"tier",
"source",
"durationMs",
"cached"
],
"properties": {
"tier": {
"const": 1
},
"source": {
"type": "string",
"format": "uri"
},
"durationMs": {
"type": "number"
},
"cached": {
"type": "boolean"
},
"ageMs": {
"type": "number"
},
"definitionVersion": {
"type": "string"
},
"snapshot": {
"type": "string"
},
"mirroredAt": {
"type": "string",
"format": "date-time"
},
"complete": {
"type": "boolean"
},
"sourceWarnings": {
"type": "array",
"description": "Source records that do not establish a requested capacity minimum; not verified matches.",
"items": {
"type": "object"
}
}
}
}
},
"additionalProperties": false
}Get source/design/document counts, snapshot completeness, retrieval time, totals and full-download links.
GET https://gradientdeck.api.whox.ai/v1/stats
| Argument | Type | Required | Description |
|---|
{
"type": "object",
"required": [
"ok",
"service",
"operation",
"data",
"meta"
],
"properties": {
"ok": {
"const": true
},
"service": {
"type": "string"
},
"operation": {
"type": "string"
},
"data": {
"type": "object",
"required": [
"source",
"fetchedAt",
"sourceDesigns",
"documents",
"complete",
"id",
"librarySha256",
"totalBytes",
"themes",
"industries",
"compactDocuments",
"extendedDocuments",
"archiveUrl",
"libraryUrl"
],
"properties": {
"source": {
"type": "string",
"format": "uri"
},
"fetchedAt": {
"type": "string",
"format": "date-time"
},
"sourceDesigns": {
"type": "integer",
"minimum": 0
},
"documents": {
"type": "integer",
"minimum": 0
},
"complete": {
"const": true
},
"id": {
"type": "string"
},
"librarySha256": {
"type": "string"
},
"totalBytes": {
"type": "integer",
"minimum": 0
},
"themes": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"count"
],
"properties": {
"value": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
},
"industries": {
"type": "array",
"items": {
"type": "object",
"required": [
"value",
"count"
],
"properties": {
"value": {
"type": "string"
},
"count": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
},
"compactDocuments": {
"type": "integer",
"minimum": 0
},
"extendedDocuments": {
"type": "integer",
"minimum": 0
},
"archiveUrl": {
"type": "string",
"format": "uri"
},
"libraryUrl": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"required": [
"tier",
"source",
"durationMs",
"cached"
],
"properties": {
"tier": {
"const": 1
},
"source": {
"type": "string",
"format": "uri"
},
"durationMs": {
"type": "number"
},
"cached": {
"type": "boolean"
},
"ageMs": {
"type": "number"
},
"definitionVersion": {
"type": "string"
},
"snapshot": {
"type": "string"
},
"mirroredAt": {
"type": "string",
"format": "date-time"
},
"complete": {
"type": "boolean"
},
"sourceWarnings": {
"type": "array",
"description": "Source records that do not establish a requested capacity minimum; not verified matches.",
"items": {
"type": "object"
}
}
}
}
},
"additionalProperties": false
}Export all matching designs and complete Markdown in bounded pages. Follow nextOffset, or download archive.zip for the full library.
GET https://gradientdeck.api.whox.ai/v1/export
| Argument | Type | Required | Description |
|---|---|---|---|
| q | string | No | Case-insensitive AND search across site metadata; set content=true to also search both complete Markdown files. |
| theme | string | No | Exact theme. |
| industry | string | No | Exact industry code from filters. |
| font | string | No | Case-insensitive font-name substring. |
| color | string | No | Exact palette hex color. URL-encode # as %23. |
| content | boolean | No | Include full Markdown in q search; default false. |
| sort | string | No | Newest follows source library order; name sorts by title. |
| offset | number | No | Zero-based offset. |
| limit | number | No | Requested designs per page; response byte bounds can reduce the returned count. |
| variant | string | No | Which original source Markdown to return. |
{
"type": "object",
"required": [
"ok",
"service",
"operation",
"data",
"meta"
],
"properties": {
"ok": {
"const": true
},
"service": {
"type": "string"
},
"operation": {
"type": "string"
},
"data": {
"type": "object",
"required": [
"total",
"offset",
"limit",
"returned",
"nextOffset",
"results"
],
"properties": {
"total": {
"type": "integer",
"minimum": 0
},
"offset": {
"type": "integer",
"minimum": 0
},
"limit": {
"type": "integer",
"minimum": 0
},
"returned": {
"type": "integer",
"minimum": 0
},
"nextOffset": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"slug",
"name",
"nickname",
"industry",
"theme",
"host",
"colors",
"fonts",
"sourceUrl",
"documents",
"apiUrl"
],
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"nickname": {
"type": "string"
},
"industry": {
"type": "string"
},
"theme": {
"enum": [
"light",
"dark",
"mixed"
]
},
"host": {
"type": "string"
},
"cover_asset": {
"type": [
"object",
"null"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"alt": {
"type": "string"
},
"width": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"height": {
"type": [
"integer",
"null"
],
"minimum": 0
}
},
"additionalProperties": true
},
"video": {
"type": [
"string",
"null"
]
},
"icon": {
"type": [
"object",
"null"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"dark": {
"type": "boolean"
}
},
"additionalProperties": true
},
"tone": {
"type": "object",
"properties": {
"bg": {
"type": "string"
},
"ink": {
"type": "string"
}
}
},
"colors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"hex"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"hex": {
"type": "string"
}
},
"additionalProperties": true
}
},
"fonts": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"type": "string",
"format": "uri"
},
"documents": {
"type": "object",
"properties": {
"compact": {
"type": "string",
"format": "uri"
},
"extended": {
"type": "string",
"format": "uri"
}
}
},
"apiUrl": {
"type": "string",
"format": "uri"
},
"content": {
"type": "object",
"properties": {
"compact": {
"type": "object",
"required": [
"variant",
"markdown",
"sections",
"url",
"sha256",
"bytes",
"fetchedAt"
],
"properties": {
"retrievalUrl": {
"type": "string",
"format": "uri"
},
"retrievalMethod": {
"enum": [
"direct-markdown",
"public-page-export"
]
},
"variant": {
"enum": [
"compact",
"extended"
]
},
"markdown": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"heading",
"markdown"
],
"properties": {
"id": {
"type": "string"
},
"heading": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"additionalProperties": false
}
},
"url": {
"type": "string",
"format": "uri"
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"fetchedAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"extended": {
"type": "object",
"required": [
"variant",
"markdown",
"sections",
"url",
"sha256",
"bytes",
"fetchedAt"
],
"properties": {
"retrievalUrl": {
"type": "string",
"format": "uri"
},
"retrievalMethod": {
"enum": [
"direct-markdown",
"public-page-export"
]
},
"variant": {
"enum": [
"compact",
"extended"
]
},
"markdown": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"heading",
"markdown"
],
"properties": {
"id": {
"type": "string"
},
"heading": {
"type": "string"
},
"markdown": {
"type": "string"
}
},
"additionalProperties": false
}
},
"url": {
"type": "string",
"format": "uri"
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"bytes": {
"type": "integer",
"minimum": 0
},
"fetchedAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": true
}
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"required": [
"tier",
"source",
"durationMs",
"cached"
],
"properties": {
"tier": {
"const": 1
},
"source": {
"type": "string",
"format": "uri"
},
"durationMs": {
"type": "number"
},
"cached": {
"type": "boolean"
},
"ageMs": {
"type": "number"
},
"definitionVersion": {
"type": "string"
},
"snapshot": {
"type": "string"
},
"mirroredAt": {
"type": "string",
"format": "date-time"
},
"complete": {
"type": "boolean"
},
"sourceWarnings": {
"type": "array",
"description": "Source records that do not establish a requested capacity minimum; not verified matches.",
"items": {
"type": "object"
}
}
}
}
},
"additionalProperties": false
}Limits:60 requests/minute/client; source limits also apply. Local snapshot reads; source refresh occurs separately. Errors return JSON with a code and message, using400/404/429/502/503/504. API keys, cookies and WHOX account sessions are never shared.