{
    "openapi": "3.1.0",
    "jsonSchemaDialect": "https://spec.openapis.org/oas/3.1/dialect/base",
    "info": {
        "title": "Zendesk API",
        "version": "1.0.0",
        "summary": "Search and read the documents, pages and hubs Zendesk publishes at https://zendesk.relayto.com/; no API key.",
        "description": "Search and read what Zendesk publishes at https://zendesk.relayto.com/: its site pages, hubs (curated collections) and documents, with the text of each as Markdown. The API returns only what any visitor can open without signing in.\n\n**Authentication:** none. There is no API key or sign-up. Nothing changes the site: every operation reads, and the one POST (`createExport`) only starts a job that collects the text of several documents. It is safe to call against the live site.\n\n**Sandbox:** the second server, `https://zendesk.relayto.com/api/site/sandbox/v1`, answers every operation over a fixed sample dataset (an imaginary company), including a 403 and an email-gated case, so an integration can be tested against known answers.\n\n**Long-running work:** `createExport` answers `202 Accepted` with a `Location` and an export id; `getExport` at that Location returns the result, built from the current content on every read. Nothing is stored: the export id carries the request, so a retried POST (with or without an `Idempotency-Key`) gets the same export.\n\n**Pagination:** list operations take `limit` (1-50, default 10) and an opaque `cursor`; pass `pagination.nextCursor` from one page to get the next, until `pagination.hasMore` is false.\n\n**Errors:** every 4xx and 5xx answer is an RFC 9457 problem (`application/problem+json`) with a stable machine-readable `code` and a `hint` on what to do next.\n\n**Rate limits:** 120 requests per 60 seconds per client IP. Every answer carries `RateLimit` and `RateLimit-Policy` headers (IETF draft-ietf-httpapi-ratelimit-headers) and their `RateLimit-Limit`/`-Remaining`/`-Reset` forms; a 429 adds `Retry-After`.\n\n**Versioning:** the major version is in the path (`/api/site/v1`). Within v1, changes are additive only: new endpoints, parameters and response fields. Anything that would break a client ships as a new major version alongside v1. A version that will be retired keeps working for at least 6 months after it is deprecated; during that time its answers carry `Deprecation` (RFC 9745) and `Sunset` (RFC 8594) headers and a `Link` with rel=\"deprecation\" to the notice on the developer page.\n\nThe API is served by RELAYTO, the platform Zendesk publishes this site on. Changing the site's content is not possible through this API."
    },
    "servers": [
        {
            "url": "https://zendesk.relayto.com/api/site/v1",
            "description": "Zendesk (live site)"
        },
        {
            "url": "https://zendesk.relayto.com/api/site/sandbox/v1",
            "description": "Sandbox: fixed sample data of an imaginary company, in the same shape, for testing an integration"
        }
    ],
    "externalDocs": {
        "description": "Zendesk API documentation",
        "url": "https://zendesk.relayto.com/developers"
    },
    "security": [],
    "tags": [
        {
            "name": "Site",
            "description": "What the site is and where its documents for agents are."
        },
        {
            "name": "Search",
            "description": "Find pages, hubs and documents by keyword."
        },
        {
            "name": "Pages",
            "description": "The pages of the site the workspace publishes at its domain."
        },
        {
            "name": "Hubs",
            "description": "Curated collections of documents and other hubs."
        },
        {
            "name": "Contents",
            "description": "Documents, presentations, videos and web pages, with their text as Markdown."
        },
        {
            "name": "Exports",
            "description": "Collect the text of many documents in one asynchronous job."
        }
    ],
    "paths": {
        "/": {
            "get": {
                "operationId": "getSite",
                "tags": [
                    "Site"
                ],
                "summary": "Get the site and its API links",
                "description": "Returns the name and description of this site and the links to its OpenAPI document, developer documentation and site index for agents (llms.txt). Call it first to check the API answers.",
                "responses": {
                    "200": {
                        "description": "The site.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Site"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing matches on this site (`not_found`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "Rate limit exceeded (`rate_limited`); retry after `Retry-After` seconds.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Retry-After": {
                                "$ref": "#/components/headers/Retry-After"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "The server failed (`internal_error`); safe to retry.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/search": {
            "get": {
                "operationId": "searchSite",
                "tags": [
                    "Search"
                ],
                "summary": "Search the site by keyword",
                "description": "Finds pages, hubs and documents of the site whose title or summary contain the words of `q`, best matches first (a word in the title counts more than one in the summary). Each result has a `kind`; read a page or document with `getContent` and a hub with `getHub`.",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/Query"
                    },
                    {
                        "$ref": "#/components/parameters/Kind"
                    },
                    {
                        "$ref": "#/components/parameters/Limit"
                    },
                    {
                        "$ref": "#/components/parameters/Cursor"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Matching pages, hubs and documents, best first.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Link": {
                                "$ref": "#/components/headers/Link"
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/SearchResults"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A parameter or the body is invalid (`invalid_parameter`, `invalid_body`), or the cursor belongs to another list (`invalid_cursor`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing matches on this site (`not_found`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "Rate limit exceeded (`rate_limited`); retry after `Retry-After` seconds.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Retry-After": {
                                "$ref": "#/components/headers/Retry-After"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "The server failed (`internal_error`); safe to retry.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/pages": {
            "get": {
                "operationId": "listPages",
                "tags": [
                    "Pages"
                ],
                "summary": "List the pages of the site",
                "description": "Lists the pages of the website the workspace publishes at its domain (home page first, then the other pages in site order). Empty when the workspace publishes no custom site. Read one with `getContent`.",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/Limit"
                    },
                    {
                        "$ref": "#/components/parameters/Cursor"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of site pages.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Link": {
                                "$ref": "#/components/headers/Link"
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ItemList"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A parameter or the body is invalid (`invalid_parameter`, `invalid_body`), or the cursor belongs to another list (`invalid_cursor`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing matches on this site (`not_found`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "Rate limit exceeded (`rate_limited`); retry after `Retry-After` seconds.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Retry-After": {
                                "$ref": "#/components/headers/Retry-After"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "The server failed (`internal_error`); safe to retry.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/hubs": {
            "get": {
                "operationId": "listHubs",
                "tags": [
                    "Hubs"
                ],
                "summary": "List the hubs of the site",
                "description": "Lists the public hubs (curated collections of documents) of the site, most recently updated first. List what one contains with `listHubItems`.",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/Limit"
                    },
                    {
                        "$ref": "#/components/parameters/Cursor"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of hubs.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Link": {
                                "$ref": "#/components/headers/Link"
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ItemList"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A parameter or the body is invalid (`invalid_parameter`, `invalid_body`), or the cursor belongs to another list (`invalid_cursor`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing matches on this site (`not_found`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "Rate limit exceeded (`rate_limited`); retry after `Retry-After` seconds.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Retry-After": {
                                "$ref": "#/components/headers/Retry-After"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "The server failed (`internal_error`); safe to retry.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/hubs/{hubSlug}": {
            "get": {
                "operationId": "getHub",
                "tags": [
                    "Hubs"
                ],
                "summary": "Get a hub",
                "description": "Returns one hub: its title, description, addresses and how many items it holds. A hub behind a password, sign-in or email form answers 403.",
                "parameters": [
                    {
                        "name": "hubSlug",
                        "in": "path",
                        "required": true,
                        "description": "The hub's slug or 13-character code, from `listHubs` or `searchSite`.",
                        "schema": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 300,
                            "pattern": "^[A-Za-z0-9][A-Za-z0-9_~-]*$"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The hub.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Hub"
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The content or hub is not public (`not_public`): private, or behind a password, sign-in or email form. No credential of this API unlocks it.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing matches on this site (`not_found`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "Rate limit exceeded (`rate_limited`); retry after `Retry-After` seconds.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Retry-After": {
                                "$ref": "#/components/headers/Retry-After"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "The server failed (`internal_error`); safe to retry.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/hubs/{hubSlug}/items": {
            "get": {
                "operationId": "listHubItems",
                "tags": [
                    "Hubs"
                ],
                "summary": "List the items in a hub",
                "description": "Lists the documents and sub-hubs a hub contains, in the order the hub sets. Items behind a password, sign-in or email form are left out.",
                "parameters": [
                    {
                        "name": "hubSlug",
                        "in": "path",
                        "required": true,
                        "description": "The hub's slug or 13-character code, from `listHubs` or `searchSite`.",
                        "schema": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 300,
                            "pattern": "^[A-Za-z0-9][A-Za-z0-9_~-]*$"
                        }
                    },
                    {
                        "$ref": "#/components/parameters/Limit"
                    },
                    {
                        "$ref": "#/components/parameters/Cursor"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of the hub's items.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Link": {
                                "$ref": "#/components/headers/Link"
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ItemList"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A parameter or the body is invalid (`invalid_parameter`, `invalid_body`), or the cursor belongs to another list (`invalid_cursor`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The content or hub is not public (`not_public`): private, or behind a password, sign-in or email form. No credential of this API unlocks it.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing matches on this site (`not_found`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "Rate limit exceeded (`rate_limited`); retry after `Retry-After` seconds.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Retry-After": {
                                "$ref": "#/components/headers/Retry-After"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "The server failed (`internal_error`); safe to retry.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/contents": {
            "get": {
                "operationId": "listContents",
                "tags": [
                    "Contents"
                ],
                "summary": "List the documents of the site",
                "description": "Lists the public documents, presentations, videos and web pages in the workspace library, most recently updated first. Pages of the site itself are listed by `listPages`. Read one with `getContent`.",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/Limit"
                    },
                    {
                        "$ref": "#/components/parameters/Cursor"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "A page of documents.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Link": {
                                "$ref": "#/components/headers/Link"
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ItemList"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A parameter or the body is invalid (`invalid_parameter`, `invalid_body`), or the cursor belongs to another list (`invalid_cursor`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing matches on this site (`not_found`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "Rate limit exceeded (`rate_limited`); retry after `Retry-After` seconds.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Retry-After": {
                                "$ref": "#/components/headers/Retry-After"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "The server failed (`internal_error`); safe to retry.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/contents/{contentSlug}": {
            "get": {
                "operationId": "getContent",
                "tags": [
                    "Contents"
                ],
                "summary": "Get a document or page with its text",
                "description": "Returns one document or site page: its metadata and its Markdown version with the full text of every page. When the content asks visitors for an email address or to confirm a notice first, `access` says so and `markdown` holds only its description. A content that is private or behind a password or sign-in answers 403.",
                "parameters": [
                    {
                        "name": "contentSlug",
                        "in": "path",
                        "required": true,
                        "description": "The slug or 13-character code of a document or page, from `listContents`, `listPages`, `listHubItems` or `searchSite`.",
                        "schema": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 300,
                            "pattern": "^[A-Za-z0-9][A-Za-z0-9_~-]*$"
                        },
                        "example": "setting-up-xgl0c3bwqyydy"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The document or page.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Content"
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The content or hub is not public (`not_public`): private, or behind a password, sign-in or email form. No credential of this API unlocks it.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing matches on this site (`not_found`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "Rate limit exceeded (`rate_limited`); retry after `Retry-After` seconds.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Retry-After": {
                                "$ref": "#/components/headers/Retry-After"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "The server failed (`internal_error`); safe to retry.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/exports": {
            "post": {
                "operationId": "createExport",
                "tags": [
                    "Exports"
                ],
                "summary": "Start an export of several documents",
                "description": "Accepts an export of the Markdown of up to 10 documents, given by slug, or of the first 10 documents in a hub. Answers `202 Accepted` at once with the job and its `Location`; `getExport` at that Location returns `items`, read when you ask, so each has the text `getContent` returns at that moment: gated documents come back as `not_public` or with their description only. Nothing is stored and nothing changes: the export id carries the request, so the same body always gets the same id. Send an `Idempotency-Key` header to retry safely; a retry with the same key and body gets the same export and `Idempotent-Replayed: true`. A key reused with a different body is simply a different request and gets a different export.",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/IdempotencyKey"
                    }
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/ExportRequest"
                            }
                        }
                    }
                },
                "responses": {
                    "202": {
                        "description": "The export, `accepted`: its result is at `Location` (`statusUrl`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Location": {
                                "$ref": "#/components/headers/Location"
                            },
                            "Idempotent-Replayed": {
                                "$ref": "#/components/headers/Idempotent-Replayed"
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ExportJob"
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "A parameter or the body is invalid (`invalid_parameter`, `invalid_body`), or the cursor belongs to another list (`invalid_cursor`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "The content or hub is not public (`not_public`): private, or behind a password, sign-in or email form. No credential of this API unlocks it.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing matches on this site (`not_found`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "Rate limit exceeded (`rate_limited`); retry after `Retry-After` seconds.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Retry-After": {
                                "$ref": "#/components/headers/Retry-After"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "The server failed (`internal_error`); safe to retry.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/exports/{exportId}": {
            "get": {
                "operationId": "getExport",
                "tags": [
                    "Exports"
                ],
                "summary": "Get an export job and its result",
                "description": "Returns the export, `completed` with `items` read now from the current content (or `failed` with `error` when its hub is gone or no longer public). Each document read counts against the rate limit, as it would through `getContent` (a hub export counts 10). An id this site did not issue, or issued before its domain moved to another workspace, answers 404.",
                "parameters": [
                    {
                        "$ref": "#/components/parameters/ExportId"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The export and its documents.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ExportJob"
                                }
                            }
                        }
                    },
                    "404": {
                        "description": "Nothing matches on this site (`not_found`).",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "429": {
                        "description": "Rate limit exceeded (`rate_limited`); retry after `Retry-After` seconds.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            },
                            "Retry-After": {
                                "$ref": "#/components/headers/Retry-After"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "The server failed (`internal_error`); safe to retry.",
                        "headers": {
                            "RateLimit": {
                                "$ref": "#/components/headers/RateLimit"
                            },
                            "RateLimit-Policy": {
                                "$ref": "#/components/headers/RateLimit-Policy"
                            },
                            "RateLimit-Limit": {
                                "$ref": "#/components/headers/RateLimit-Limit"
                            },
                            "RateLimit-Remaining": {
                                "$ref": "#/components/headers/RateLimit-Remaining"
                            },
                            "RateLimit-Reset": {
                                "$ref": "#/components/headers/RateLimit-Reset"
                            }
                        },
                        "content": {
                            "application/problem+json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Problem"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "components": {
        "parameters": {
            "IdempotencyKey": {
                "name": "Idempotency-Key",
                "in": "header",
                "required": false,
                "description": "A key for safe retries (a UUID, for example). The export id is derived from the request, so a retry with the same key and body gets the same export, with `Idempotent-Replayed: true`. The API keeps no state, so it cannot tell a key reused with a different body: that is a different request and gets a different export.",
                "schema": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255
                }
            },
            "ExportId": {
                "name": "exportId",
                "in": "path",
                "required": true,
                "description": "The `id` createExport returned: a signed token that carries the request.",
                "schema": {
                    "type": "string",
                    "maxLength": 2000,
                    "pattern": "^[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]{43}$"
                }
            },
            "Query": {
                "name": "q",
                "in": "query",
                "required": true,
                "description": "Words to look for in titles and summaries, for example a topic or a document name.",
                "schema": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200
                },
                "example": "setting"
            },
            "Kind": {
                "name": "kind",
                "in": "query",
                "required": false,
                "description": "Only return results of this kind: `page` (a page of the site), `hub` or `content` (a document).",
                "schema": {
                    "type": "string",
                    "enum": [
                        "page",
                        "hub",
                        "content"
                    ]
                }
            },
            "Limit": {
                "name": "limit",
                "in": "query",
                "required": false,
                "description": "How many items to return, 1-50.",
                "schema": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 50,
                    "default": 10
                }
            },
            "Cursor": {
                "name": "cursor",
                "in": "query",
                "required": false,
                "description": "Opaque position in the list: `pagination.nextCursor` of the previous page. Omit it for the first page.",
                "schema": {
                    "type": "string",
                    "maxLength": 200
                }
            }
        },
        "headers": {
            "RateLimit": {
                "description": "Quota left in the current window (draft-ietf-httpapi-ratelimit-headers): `\"per-client\";r=<remaining>;t=<seconds until reset>`.",
                "schema": {
                    "type": "string"
                },
                "example": "\"per-client\";r=119;t=60"
            },
            "RateLimit-Policy": {
                "description": "The quota policy: `\"per-client\";q=120;w=60` (120 requests per 60-second window, per client IP).",
                "schema": {
                    "type": "string"
                },
                "example": "\"per-client\";q=120;w=60"
            },
            "RateLimit-Limit": {
                "description": "Requests allowed per window.",
                "schema": {
                    "type": "integer"
                }
            },
            "RateLimit-Remaining": {
                "description": "Requests left in the current window.",
                "schema": {
                    "type": "integer"
                }
            },
            "RateLimit-Reset": {
                "description": "Seconds until the current window ends.",
                "schema": {
                    "type": "integer"
                }
            },
            "Retry-After": {
                "description": "Seconds to wait before retrying.",
                "schema": {
                    "type": "integer"
                }
            },
            "Link": {
                "description": "RFC 8288 link to the next page (rel=\"next\") when there is one.",
                "schema": {
                    "type": "string"
                }
            },
            "Location": {
                "description": "URL of the export's result (getExport).",
                "schema": {
                    "type": "string",
                    "format": "uri"
                }
            },
            "Idempotent-Replayed": {
                "description": "`true` when the request carried an Idempotency-Key: the answer is the export every request with that key and body gets.",
                "schema": {
                    "type": "string",
                    "enum": [
                        "true"
                    ]
                }
            }
        },
        "schemas": {
            "Item": {
                "type": "object",
                "description": "A page, hub or document of the site, as lists and search return it.",
                "required": [
                    "kind",
                    "slug",
                    "title",
                    "summary",
                    "format",
                    "url",
                    "markdownUrl",
                    "apiUrl",
                    "updated"
                ],
                "properties": {
                    "kind": {
                        "type": "string",
                        "enum": [
                            "page",
                            "hub",
                            "content"
                        ],
                        "description": "`page`: a page of the site; `hub`: a collection; `content`: a document in the library."
                    },
                    "slug": {
                        "type": "string",
                        "description": "Identifier to pass to `getContent` (pages and contents) or `getHub` (hubs)."
                    },
                    "title": {
                        "type": "string",
                        "description": "Title, as plain text."
                    },
                    "summary": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "description": "Subtitle or description, as plain text, at most 300 characters."
                    },
                    "format": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "enum": [
                            "pdf",
                            "document",
                            "web-page",
                            "article",
                            "video",
                            "audio",
                            "image",
                            "link",
                            "other",
                            null
                        ],
                        "description": "What the page or document is; null for hubs."
                    },
                    "url": {
                        "type": "string",
                        "format": "uri",
                        "description": "The interactive page on the site, for people."
                    },
                    "markdownUrl": {
                        "type": "string",
                        "format": "uri",
                        "description": "The Markdown version of the page, for agents."
                    },
                    "apiUrl": {
                        "type": "string",
                        "format": "uri",
                        "description": "This resource in the API (`getContent` or `getHub`)."
                    },
                    "updated": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date-time",
                        "description": "Last update, UTC."
                    }
                },
                "additionalProperties": false
            },
            "Pagination": {
                "type": "object",
                "description": "Cursor pagination: pass `nextCursor` as `cursor` to get the next page.",
                "required": [
                    "limit",
                    "hasMore",
                    "nextCursor"
                ],
                "properties": {
                    "limit": {
                        "type": "integer",
                        "minimum": 1,
                        "maximum": 50,
                        "description": "Page size used."
                    },
                    "hasMore": {
                        "type": "boolean",
                        "description": "Whether another page follows."
                    },
                    "nextCursor": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "description": "Cursor of the next page; null on the last page."
                    }
                },
                "additionalProperties": false
            },
            "Links": {
                "type": "object",
                "required": [
                    "self",
                    "next"
                ],
                "properties": {
                    "self": {
                        "type": "string",
                        "format": "uri",
                        "description": "This page."
                    },
                    "next": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "uri",
                        "description": "The next page, or null."
                    }
                },
                "additionalProperties": false
            },
            "ItemList": {
                "type": "object",
                "description": "One page of a list.",
                "required": [
                    "data",
                    "pagination",
                    "links"
                ],
                "properties": {
                    "data": {
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/Item"
                        }
                    },
                    "pagination": {
                        "$ref": "#/components/schemas/Pagination"
                    },
                    "links": {
                        "$ref": "#/components/schemas/Links"
                    }
                },
                "additionalProperties": false
            },
            "SearchResults": {
                "type": "object",
                "description": "One page of search results, best match first.",
                "required": [
                    "query",
                    "data",
                    "pagination",
                    "links"
                ],
                "properties": {
                    "query": {
                        "type": "string",
                        "description": "The query as searched."
                    },
                    "data": {
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/Item"
                        }
                    },
                    "pagination": {
                        "$ref": "#/components/schemas/Pagination"
                    },
                    "links": {
                        "$ref": "#/components/schemas/Links"
                    }
                },
                "additionalProperties": false
            },
            "Content": {
                "type": "object",
                "description": "A document or page of the site with its Markdown version.",
                "required": [
                    "kind",
                    "slug",
                    "title",
                    "summary",
                    "format",
                    "url",
                    "markdownUrl",
                    "apiUrl",
                    "updated",
                    "subtitle",
                    "description",
                    "pageCount",
                    "access",
                    "textIncluded",
                    "indexable",
                    "publisher",
                    "markdown"
                ],
                "properties": {
                    "kind": {
                        "type": "string",
                        "enum": [
                            "page",
                            "hub",
                            "content"
                        ],
                        "description": "`page`: a page of the site; `hub`: a collection; `content`: a document in the library."
                    },
                    "slug": {
                        "type": "string",
                        "description": "Identifier to pass to `getContent` (pages and contents) or `getHub` (hubs)."
                    },
                    "title": {
                        "type": "string",
                        "description": "Title, as plain text."
                    },
                    "summary": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "description": "Subtitle or description, as plain text, at most 300 characters."
                    },
                    "format": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "enum": [
                            "pdf",
                            "document",
                            "web-page",
                            "article",
                            "video",
                            "audio",
                            "image",
                            "link",
                            "other",
                            null
                        ],
                        "description": "What the page or document is; null for hubs."
                    },
                    "url": {
                        "type": "string",
                        "format": "uri",
                        "description": "The interactive page on the site, for people."
                    },
                    "markdownUrl": {
                        "type": "string",
                        "format": "uri",
                        "description": "The Markdown version of the page, for agents."
                    },
                    "apiUrl": {
                        "type": "string",
                        "format": "uri",
                        "description": "This resource in the API (`getContent` or `getHub`)."
                    },
                    "updated": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date-time",
                        "description": "Last update, UTC."
                    },
                    "subtitle": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "description": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "pageCount": {
                        "type": "integer",
                        "minimum": 0,
                        "description": "Number of pages (slides) of the document."
                    },
                    "access": {
                        "type": "string",
                        "enum": [
                            "open",
                            "email-gated",
                            "notice-gated"
                        ],
                        "description": "`open`: the text is in `markdown`. `email-gated`: visitors leave an email address first, so only the description is given. `notice-gated`: visitors confirm a notice on the page first, so only the description is given."
                    },
                    "textIncluded": {
                        "type": "boolean",
                        "description": "Whether `markdown` holds the full text."
                    },
                    "indexable": {
                        "type": "boolean",
                        "description": "Whether the site lets search engines index the page."
                    },
                    "publisher": {
                        "type": "object",
                        "description": "Who publishes the site.",
                        "required": [
                            "name",
                            "url"
                        ],
                        "properties": {
                            "name": {
                                "type": "string"
                            },
                            "url": {
                                "type": "string",
                                "format": "uri"
                            }
                        },
                        "additionalProperties": false
                    },
                    "markdown": {
                        "type": "string",
                        "description": "The Markdown version of the page, as served at `markdownUrl`."
                    }
                },
                "additionalProperties": false
            },
            "Hub": {
                "type": "object",
                "description": "A hub (curated collection) of the site.",
                "required": [
                    "kind",
                    "slug",
                    "title",
                    "summary",
                    "format",
                    "url",
                    "markdownUrl",
                    "apiUrl",
                    "updated",
                    "description",
                    "itemCount",
                    "itemsUrl",
                    "publisher"
                ],
                "properties": {
                    "kind": {
                        "type": "string",
                        "enum": [
                            "page",
                            "hub",
                            "content"
                        ],
                        "description": "`page`: a page of the site; `hub`: a collection; `content`: a document in the library."
                    },
                    "slug": {
                        "type": "string",
                        "description": "Identifier to pass to `getContent` (pages and contents) or `getHub` (hubs)."
                    },
                    "title": {
                        "type": "string",
                        "description": "Title, as plain text."
                    },
                    "summary": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "description": "Subtitle or description, as plain text, at most 300 characters."
                    },
                    "format": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "enum": [
                            "pdf",
                            "document",
                            "web-page",
                            "article",
                            "video",
                            "audio",
                            "image",
                            "link",
                            "other",
                            null
                        ],
                        "description": "What the page or document is; null for hubs."
                    },
                    "url": {
                        "type": "string",
                        "format": "uri",
                        "description": "The interactive page on the site, for people."
                    },
                    "markdownUrl": {
                        "type": "string",
                        "format": "uri",
                        "description": "The Markdown version of the page, for agents."
                    },
                    "apiUrl": {
                        "type": "string",
                        "format": "uri",
                        "description": "This resource in the API (`getContent` or `getHub`)."
                    },
                    "updated": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date-time",
                        "description": "Last update, UTC."
                    },
                    "description": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "itemCount": {
                        "type": "integer",
                        "minimum": 0,
                        "description": "Number of public items in the hub."
                    },
                    "itemsUrl": {
                        "type": "string",
                        "format": "uri",
                        "description": "The hub's items in the API (`listHubItems`)."
                    },
                    "publisher": {
                        "type": "object",
                        "description": "Who publishes the site.",
                        "required": [
                            "name",
                            "url"
                        ],
                        "properties": {
                            "name": {
                                "type": "string"
                            },
                            "url": {
                                "type": "string",
                                "format": "uri"
                            }
                        },
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            },
            "Site": {
                "type": "object",
                "description": "The site this API serves.",
                "required": [
                    "name",
                    "description",
                    "url",
                    "apiVersion",
                    "links"
                ],
                "properties": {
                    "name": {
                        "type": "string",
                        "description": "Name of the site."
                    },
                    "description": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "url": {
                        "type": "string",
                        "format": "uri",
                        "description": "Home page of the site."
                    },
                    "apiVersion": {
                        "type": "string",
                        "description": "Version of this API."
                    },
                    "links": {
                        "type": "object",
                        "required": [
                            "openapi",
                            "documentation",
                            "llmsTxt",
                            "search",
                            "hubs",
                            "contents",
                            "pages"
                        ],
                        "properties": {
                            "openapi": {
                                "type": "string",
                                "format": "uri"
                            },
                            "documentation": {
                                "type": "string",
                                "format": "uri"
                            },
                            "llmsTxt": {
                                "type": "string",
                                "format": "uri"
                            },
                            "search": {
                                "type": "string",
                                "format": "uri"
                            },
                            "hubs": {
                                "type": "string",
                                "format": "uri"
                            },
                            "contents": {
                                "type": "string",
                                "format": "uri"
                            },
                            "pages": {
                                "type": "string",
                                "format": "uri"
                            }
                        },
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            },
            "ExportRequest": {
                "type": "object",
                "description": "What to export: `contents` (1-10 slugs) or `hub` (one hub slug), not both.",
                "minProperties": 1,
                "maxProperties": 1,
                "properties": {
                    "contents": {
                        "type": "array",
                        "minItems": 1,
                        "maxItems": 10,
                        "items": {
                            "type": "string",
                            "pattern": "^[A-Za-z0-9][A-Za-z0-9_~-]*$"
                        },
                        "description": "Slugs of the documents or pages to export."
                    },
                    "hub": {
                        "type": "string",
                        "pattern": "^[A-Za-z0-9][A-Za-z0-9_~-]*$",
                        "description": "Slug of a hub: its first 10 documents are exported."
                    }
                },
                "additionalProperties": false
            },
            "ExportItem": {
                "type": "object",
                "description": "One exported document.",
                "required": [
                    "slug",
                    "status",
                    "kind",
                    "title",
                    "access",
                    "apiUrl",
                    "markdown"
                ],
                "properties": {
                    "slug": {
                        "type": "string"
                    },
                    "status": {
                        "type": "string",
                        "enum": [
                            "ok",
                            "not_public",
                            "not_found"
                        ],
                        "description": "`ok`: exported; `not_public`: private or behind a password or sign-in; `not_found`: no such document on this site."
                    },
                    "kind": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "enum": [
                            "page",
                            "content",
                            null
                        ]
                    },
                    "title": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "access": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "enum": [
                            "open",
                            "email-gated",
                            "notice-gated",
                            null
                        ],
                        "description": "As in getContent: anything but `open` means `markdown` holds the description only."
                    },
                    "apiUrl": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "uri"
                    },
                    "markdown": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "description": "The Markdown version, as getContent returns it; null unless status is `ok`."
                    }
                },
                "additionalProperties": false
            },
            "ExportJob": {
                "type": "object",
                "description": "An export job (asynchronous).",
                "required": [
                    "id",
                    "status",
                    "statusUrl",
                    "request",
                    "itemCount",
                    "items",
                    "error"
                ],
                "properties": {
                    "id": {
                        "type": "string",
                        "description": "Export id, for getExport: a signed token that carries the request."
                    },
                    "status": {
                        "type": "string",
                        "enum": [
                            "accepted",
                            "completed",
                            "failed"
                        ],
                        "description": "`accepted` in the createExport answer; `completed` or `failed` from getExport."
                    },
                    "statusUrl": {
                        "type": "string",
                        "format": "uri",
                        "description": "Where to read the result (getExport)."
                    },
                    "request": {
                        "$ref": "#/components/schemas/ExportRequest"
                    },
                    "itemCount": {
                        "type": [
                            "integer",
                            "null"
                        ],
                        "minimum": 0
                    },
                    "items": {
                        "type": [
                            "array",
                            "null"
                        ],
                        "items": {
                            "$ref": "#/components/schemas/ExportItem"
                        },
                        "description": "The exported documents, in request (or hub) order, read when getExport is called; null in the createExport answer."
                    },
                    "error": {
                        "type": [
                            "string",
                            "null"
                        ]
                    }
                },
                "additionalProperties": false
            },
            "Problem": {
                "type": "object",
                "description": "An RFC 9457 problem detail.",
                "required": [
                    "type",
                    "title",
                    "status",
                    "detail",
                    "code"
                ],
                "properties": {
                    "type": {
                        "type": "string",
                        "format": "uri",
                        "description": "Identifies the problem type; links to its entry on the developer page."
                    },
                    "title": {
                        "type": "string",
                        "description": "Short summary of the problem type."
                    },
                    "status": {
                        "type": "integer",
                        "description": "HTTP status code."
                    },
                    "detail": {
                        "type": "string",
                        "description": "What went wrong with this request."
                    },
                    "instance": {
                        "type": "string",
                        "description": "The request path."
                    },
                    "code": {
                        "type": "string",
                        "enum": [
                            "invalid_parameter",
                            "invalid_cursor",
                            "not_public",
                            "not_found",
                            "invalid_body",
                            "method_not_allowed",
                            "rate_limited",
                            "internal_error"
                        ],
                        "description": "Stable machine-readable error code."
                    },
                    "hint": {
                        "type": "string",
                        "description": "What to do about it."
                    },
                    "url": {
                        "type": "string",
                        "format": "uri",
                        "description": "For `not_public`: the page to open in a browser."
                    }
                }
            }
        }
    }
}
