BrewPage

BrewPage Short Links API

Short URL resolver for sharing

GitHub OpenAPI

Documentation

📖
Documentation
https://brewpage.app/api
📖
APIReference
https://kochetkov-ma.github.io/brewpage-openapi/
📖
Authentication
https://brewpage.app/llms-full.txt

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/openapi/brewpage-short-links-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/json-schema/brewpage-html-page-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/json-schema/brewpage-file-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/json-schema/brewpage-kv-store-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/json-schema/brewpage-json-document-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/json-schema/brewpage-site-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/json-structure/brewpage-html-page-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/json-structure/brewpage-kv-store-structure.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/examples/brewpage-create-html-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/examples/brewpage-create-markdown-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/examples/brewpage-upload-file-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/examples/brewpage-upload-site-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/brewpage/refs/heads/main/examples/brewpage-upsert-kv-example.json

OpenAPI Specification

brewpage-short-links-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: BrewPage Files Short Links API
  description: Free instant hosting for HTML, Markdown, AI artifacts and files
  version: 1.51.1
servers:
- url: https://brewpage.app
  description: Generated server url
tags:
- name: Short Links
  description: Short URL resolver for sharing
paths:
  /{ns}/{id}:
    get:
      tags:
      - Short Links
      operationId: resolve
      parameters:
      - name: ns
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: X-Password
        in: header
        description: Access password for protected resources
        required: false
        schema:
          type: string
      - name: p
        in: query
        description: Access password (query alternative to X-Password header)
        required: false
        schema:
          type: string
      - name: dl
        in: query
        description: Force download as attachment
        required: false
        schema:
          type: boolean
      - name: Range
        in: header
        required: false
        schema:
          type: string
      - name: X-Resolve
        in: header
        required: false
        schema:
          type: string
      - name: X-Owner-Token
        in: header
        description: 'Owner token; when supplied, response carries X-Is-Owner: true on match'
        required: false
        schema:
          type: string
      - name: User-Agent
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
  /{ns}/{id}/{sub}:
    get:
      tags:
      - Short Links
      operationId: resolveWithSub
      parameters:
      - name: ns
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: sub
        in: path
        required: true
        schema:
          type: string
      - name: X-Password
        in: header
        description: Access password for protected resources
        required: false
        schema:
          type: string
      - name: p
        in: query
        description: Access password (query alternative to X-Password header)
        required: false
        schema:
          type: string
      - name: dl
        in: query
        description: Force download as attachment
        required: false
        schema:
          type: boolean
      - name: X-Resolve
        in: header
        required: false
        schema:
          type: string
      - name: X-Owner-Token
        in: header
        description: 'Owner token; when supplied, response carries X-Is-Owner: true on match'
        required: false
        schema:
          type: string
      - name: User-Agent
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object