BrewPage KV API

openapi: 3.2.0
info:
  title: BrewPage KV 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: KV
  description: Key-Value store with up to 1000 keys per store
paths:
  /api/kv/{ns}/{id}/{key}:
    get:
      tags:
      - KV
      summary: Get key value
      description: Returns the value and last update timestamp for a specific key
      operationId: getKey
      parameters:
      - name: ns
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9-]{1,32}$
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: path
        required: true
        schema:
          type: string
      - name: X-Password
        in: header
        description: Access password via header
        required: false
        schema:
          type: string
      - name: p
        in: query
        description: Legacy-only query password; ignored for NEW publications. Programmatic access uses X-Password or the owner token.
        required: false
        schema:
          type: string
      - name: User-Agent
        in: header
        required: false
        schema:
          type: string
      - name: X-Owner-Token
        in: header
        description: Owner token to bypass password protection when no password supplied
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Key value
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KvGetResponse'
        '403':
          description: Wrong password
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Store or key not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - {}
      - OwnerToken: []
      - Password: []
    put:
      tags:
      - KV
      summary: Upsert key
      description: Creates or updates a key in the store; max 1000 keys per store
      operationId: upsertKey
      parameters:
      - name: ns
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9-]{1,32}$
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: path
        required: true
        schema:
          type: string
      - name: X-Owner-Token
        in: header
        description: Owner token returned at creation. Required for update and delete
        required: true
        schema:
          type: string
      - name: X-Delivery-Mode
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KvUpsertKeyRequest'
        required: true
      responses:
        '200':
          description: Key upserted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KvUpsertKeyResponse'
        '403':
          description: Missing or wrong owner token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Store not found or expired
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Key limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - OwnerToken: []
    delete:
      tags:
      - KV
      summary: Delete key
      description: Removes a single key from the store; deleting the last key does not remove the store
      operationId: deleteKey
      parameters:
      - name: ns
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9-]{1,32}$
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: path
        required: true
        schema:
          type: string
      - name: X-Owner-Token
        in: header
        description: Owner token returned at creation. Required for update and delete
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Key deleted
        '403':
          description: Missing or wrong owner token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Store or key not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - OwnerToken: []
  /api/kv:
    get:
      tags:
      - KV
      summary: List KV stores
      description: Returns all KV stores owned by the given token in the namespace. Returns empty list without token
      operationId: listStores
      parameters:
      - name: ns
        in: query
        description: Namespace (default public). Custom namespaces are unlisted, accessible to anyone with the URL. Public discovery additionally requires eligibility and no password.
        required: false
        schema:
          type: string
          default: public
          pattern: ^[a-z0-9-]{1,32}$
      - name: X-Owner-Token
        in: header
        description: Owner token to filter by ownership. Without token returns empty list
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Store list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/KvStoreListResponse'
      security:
      - {}
      - OwnerToken: []
    post:
      tags:
      - KV
      summary: Create KV store
      description: Creates a new store with an initial key-value pair and returns a shareable link. Reuse existing owner token to group entities under one owner
      operationId: createStore
      parameters:
      - name: ns
        in: query
        description: Namespace (default public). Custom namespaces are unlisted, accessible to anyone with the URL. Public discovery additionally requires eligibility and no password.
        required: false
        schema:
          type: string
          default: public
          pattern: ^[a-z0-9-]{1,32}$
      - name: tags
        in: query
        description: Comma-separated tags
        required: false
        schema:
          type: string
        example: demo,test
      - name: ttl
        in: query
        description: TTL in integer days (1-30); accepts 15, 15d, 15 day or 15 days, case-insensitive. Omitted or blank uses 15 days.
        required: false
        schema:
          type: string
          pattern: ^\s*(?:\d+\s*(?:[dD]|[dD][aA][yY][sS]?)?)?\s*$
      - name: X-Password
        in: header
        description: Access password; protected stores are unlisted. NEW browser links use trusted unlock; programmatic reads use X-Password
        required: false
        schema:
          type: string
      - name: X-Owner-Token
        in: header
        description: Reuse existing owner token to group entities under one owner. If omitted, a new token is generated
        required: false
        schema:
          type: string
      - name: X-Delivery-Mode
        in: header
        description: 'Delivery mode for a new store: path or subdomain'
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KvCreateStoreRequest'
        required: true
      responses:
        '201':
          description: Store created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KvCreateStoreResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - {}
      - OwnerToken: []
  /api/kv/{ns}/{id}:
    get:
      tags:
      - KV
      summary: List keys
      description: Returns all key names and total count for a store
      operationId: listKeys
      parameters:
      - name: ns
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9-]{1,32}$
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: X-Password
        in: header
        description: Access password via header
        required: false
        schema:
          type: string
      - name: p
        in: query
        description: Legacy-only query password; ignored for NEW publications. Programmatic access uses X-Password or the owner token.
        required: false
        schema:
          type: string
      - name: User-Agent
        in: header
        required: false
        schema:
          type: string
      - name: X-Owner-Token
        in: header
        description: Owner token to bypass password protection when no password supplied
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Key list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KvListKeysResponse'
        '403':
          description: Wrong password
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Store not found or expired
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - {}
      - OwnerToken: []
      - Password: []
    delete:
      tags:
      - KV
      summary: Delete entire KV bucket (all keys under ns/id)
      description: Permanently removes all keys in the store; requires the owner token returned at creation
      operationId: deleteKvStore
      parameters:
      - name: ns
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z0-9-]{1,32}$
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: X-Owner-Token
        in: header
        description: Owner token returned at creation. Required for delete
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Bucket deleted
        '403':
          description: Missing or wrong owner token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Store not found or expired
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - OwnerToken: []
components:
  schemas:
    KvUpsertKeyResponse:
      type: object
      properties:
        id:
          type: string
        namespace:
          type: string
        key:
          type: string
        sizeBytes:
          type: integer
          format: int64
        link:
          type: string
          description: Primary URL returned for browser viewing and sharing of this key
        ownerLink:
          type: string
          description: API URL for programmatic access
        visibilityNotice:
          type: string
          description: Human-readable explanation of link access and conditional public-discovery eligibility. Unlisted links are not secret; password protection applies when configured. No guarantee of listing, ranking or search-engine indexing.
        managementLink:
          type:
          - string
          - 'null'
        routingCohort:
          type: string
        deliveryMode:
          type:
          - string
          - 'null'
        requestedDeliveryMode:
          type:
          - string
          - 'null'
        effectiveDeliveryMode:
          type:
          - string
          - 'null'
        deliveryModeMatched:
          type:
          - boolean
          - 'null'
        access:
          type: string
        modeLocked:
          type: boolean
        hostingVersion:
          type:
          - integer
          - 'null'
          format: int64
      required:
      - access
      - deliveryMode
      - deliveryModeMatched
      - effectiveDeliveryMode
      - hostingVersion
      - id
      - key
      - link
      - managementLink
      - modeLocked
      - namespace
      - ownerLink
      - requestedDeliveryMode
      - routingCohort
      - sizeBytes
    ErrorResponse:
      type: object
      properties:
        status:
          type: integer
          format: int32
        error:
          type: string
        message:
          type: string
        timestamp:
          type: string
          format: date-time
        supportedTypes:
          type: array
          items:
            type: string
        retryAfterSeconds:
          type: integer
          format: int64
        limit:
          type: integer
          format: int32
        result:
          oneOf:
          - $ref: '#/components/schemas/AbuseResult'
        code:
          type: string
      required:
      - error
      - message
      - status
      - timestamp
    KvCreateStoreRequest:
      type: object
      properties:
        key:
          type: string
          description: Initial key name
        value:
          type: string
          description: Value for the initial key (max 1 MB)
      required:
      - key
      - value
    KvGetResponse:
      type: object
      properties:
        value:
          type: string
        updatedAt:
          type: string
          format: date-time
          description: When the value was last written or updated
        expiresAt:
          type: string
          format: date-time
          description: When the value expires
        views:
          type: integer
          format: int64
          description: Total number of reads for this key (post-increment)
      required:
      - expiresAt
      - updatedAt
      - value
      - views
    AbuseResult:
      type: object
      properties:
        code:
          type: string
          enum:
          - success
          - duplicate
          - warned
          - failed
        action:
          type: string
          enum:
          - created
          - created_missing_assets
          - updated
          - merged
          - created_warned
          - unavailable
          - rate_limited
          - rejected
        reason:
          type: string
        extras:
          type: object
          additionalProperties: {}
      required:
      - action
      - code
    KvUpsertKeyRequest:
      type: object
      properties:
        value:
          type: string
          description: New value for the key (max 1 MB)
      required:
      - value
    KvStoreListResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique 10-character alphanumeric store ID
        keyCount:
          type: integer
          format: int32
          description: Number of keys in the store
        createdAt:
          type: string
          format: date-time
          description: When the first key in the store was created
      required:
      - createdAt
      - id
      - keyCount
    KvCreateStoreResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique 10-character alphanumeric store ID
        namespace:
          type: string
        key:
          type: string
        sizeBytes:
          type: integer
          format: int64
        link:
          type: string
          description: Primary URL returned for browser viewing and sharing of the initial key
        ownerLink:
          type: string
          description: API URL for programmatic access (upsert/delete)
        expiresAt:
          type: string
          format: date-time
        tags:
          type: array
          items:
            type: string
        ownerToken:
          type: string
          description: Secret token required for upsert and delete operations. Store it safely -- cannot be recovered
        visibilityNotice:
          type: string
          description: Human-readable explanation of link access and conditional public-discovery eligibility. Unlisted links are not secret; password protection applies when configured. No guarantee of listing, ranking or search-engine indexing.
        managementLink:
          type:
          - string
          - 'null'
        routingCohort:
          type: string
        deliveryMode:
          type:
          - string
          - 'null'
        requestedDeliveryMode:
          type:
          - string
          - 'null'
        effectiveDeliveryMode:
          type:
          - string
          - 'null'
        deliveryModeMatched:
          type:
          - boolean
          - 'null'
        access:
          type: string
        modeLocked:
          type: boolean
        hostingVersion:
          type:
          - integer
          - 'null'
          format: int64
      required:
      - access
      - deliveryMode
      - deliveryModeMatched
      - effectiveDeliveryMode
      - expiresAt
      - hostingVersion
      - id
      - key
      - link
      - managementLink
      - modeLocked
      - namespace
      - ownerLink
      - ownerToken
      - requestedDeliveryMode
      - routingCohort
      - sizeBytes
      - tags
    KvListKeysResponse:
      type: object
      properties:
        keys:
          type: array
          description: All key names in the store
          items:
            type: string
        count:
          type: integer
          format: int32
          description: Total number of keys
        expiresAt:
          type: string
          format: date-time
          description: When the store expires
        views:
          type: integer
          format: int64
          description: Aggregated views across all keys in this store
      required:
      - count
      - expiresAt
      - keys
      - views
  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)