BrewPage SEO API

openapi: 3.2.0
info:
  title: BrewPage SEO API
  description: Free instant hosting for HTML, Markdown, JSON, key-value stores, files and sites. REST omission defaults to the public namespace; MCP omission creates an unlisted namespace. Unlisted URLs are accessible to anyone with the link; use a password for access restrictions. Retain returned links and ownership tokens. Public discovery requires eligibility; protected and non-public publications are excluded.
  termsOfService: https://brewpage.app/terms
  contact:
    name: BrewPage
    url: https://brewpage.app
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 1.112.0
servers:
- url: https://brewpage.app
  description: Generated server url
tags:
- name: SEO
  description: Search engine optimization endpoints
paths:
  /{key}.txt:
    get:
      tags:
      - SEO
      summary: IndexNow key verification
      description: Serves the IndexNow verification key file for search engine crawlers
      operationId: serveKeyFile
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Key file content
          content:
            text/plain:
              schema:
                type: string
        '404':
          description: Unknown key
  /galleries:
    get:
      tags:
      - SEO
      summary: Flat HTML index of all current public publications
      description: Renders a minimal, bot-friendly anchor index of every current public site, page, image and video. Sorted by popularity (top 50 by views) then by recency. Underlying data is cached for ~2h.
      operationId: galleries
      responses:
        '200':
          description: HTML index page
          content:
            '*/*':
              schema:
                type: string
  /api/sitemap.xml:
    get:
      tags:
      - SEO
      summary: Dynamic XML sitemap
      description: Generates sitemap with static pages and all public gallery entries. Caddy should route /sitemap.xml to this endpoint
      operationId: sitemap
      responses:
        '200':
          description: Sitemap XML
          content:
            application/xml:
              schema:
                type: string
  /api/sitemap-index.xml:
    get:
      tags:
      - SEO
      summary: Top-level sitemap index
      description: sitemaps.org 0.9 sitemapindex pointing at /sitemap.xml and /sitemap-images.xml. Advertised in robots.txt so crawlers discover both children from a single URL. Caddy should route /sitemap-index.xml to this endpoint.
      operationId: sitemapIndex
      responses:
        '200':
          description: Sitemap index XML
          content:
            application/xml:
              schema:
                type: string
  /api/sitemap-images.xml:
    get:
      tags:
      - SEO
      summary: Google image-sitemap
      description: Per-content OG preview URLs (sitemap-image/1.1) for every qualifying public HTML/site publication. Reuses the publishable-items Caffeine cache slot shared with /sitemap.xml. Caddy should route /sitemap-images.xml to this endpoint.
      operationId: sitemapImages
      responses:
        '200':
          description: Image sitemap XML
          content:
            application/xml:
              schema:
                type: string
components:
  securitySchemes:
    OwnerToken:
      type: apiKey
      name: X-Owner-Token
      in: header
    Password:
      type: apiKey
      name: X-Password
      in: header
externalDocs:
  description: BrewPage API documentation (Scalar)
  url: https://kochetkov-ma.github.io/brewpage-openapi/
x-provenance:
  method: harvested
  publisher: BrewPage
  source: https://brewpage.app/v3/api-docs
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)