HTMLvault API

openapi: 3.1.0
info:
  title: HTMLvault API
  version: '2026-11-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-11: 4 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; HTMLvault has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 1
    pages-with-code: 3
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://htmlvault.com/docs/mcp
  - https://htmlvault.com/docs/documents
  - https://htmlvault.com/docs/images
paths:
  /api/mcp:
    get:
      operationId: get_api_mcp
      tags:
      - Api
      summary: GET /api/mcp
      x-source: https://htmlvault.com/docs/mcp
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl and no glue code. The endpoint is Streamable HTTP at https://htmlvault.com/api/mcp, and every plan can connect. Free accounts
          sign in over OAuth and get the publish, edit, read, analytics, delete and scan tools within the same limits as the web upload form.
          Static API keys, batch creation and recipient links need a paid plan (Pro, Teams or Enterprise). Endpoint https://htmlvault.com/api/mcp
          T
  /api/v1/assets:
    post:
      operationId: post_api_v1_assets
      tags:
      - Api
      summary: POST /api/v1/assets
      x-source: https://htmlvault.com/docs/images
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1AssetsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://htmlvault.com/api/v1/assets  -H "Authorization: Bearer hv_..."  -H "Content-Type: application/json"  -d
          ''{ "content_type": "image/png", "bytes": 48213 }'' Field Type Description content_type Required string image/png , image/jpeg , image/webp
          , image/gif or image/avif : the Content-Type you will send the file with. It is signed into the upload URL. bytes number The file’s
          size,'
  /api/v1/assets/4fQk2ZpX9LmA7bRt1VcW8e/complete:
    post:
      operationId: post_api_v1_assets_4fQk2ZpX9LmA7bRt1VcW8e_complete
      tags:
      - Api
      summary: Complete the upload
      x-source: https://htmlvault.com/docs/images
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1Assets4Fqk2Zpx9Lma7Brt1Vcw8ECompleteResponse'
      x-evidence:
        kind: documentation
  /api/v1/links/document:
    post:
      operationId: post_api_v1_links_document
      tags:
      - Api
      summary: POST /api/v1/links/document
      x-source: https://htmlvault.com/docs/documents
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1LinksDocumentRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://htmlvault.com/api/v1/links/document  -H \"Authorization: Bearer hv_...\"  -H \"Content-Type: application/json\"\
          \  -d '{\n \"title\": \"Q3 plan\",\n \"html\": \"<h1>Q3 plan</h1><p>Where we are.</p><figure data-figure=\\\"flow\\\"><figcaption>How\
          \ a request moves</figcaption></figure>\",\n \"figures\": {\n \"flow\": { \"mermaid\": \"flowchart LR\\n A[Request] --> B[Review] -->\
          \ C[Ship]\", \"alt\": \"Request, revi"
components:
  schemas:
    PostApiV1AssetsRequest:
      type: object
      properties:
        content_type:
          type: string
        bytes:
          type: integer
    PostApiV1Assets4Fqk2Zpx9Lma7Brt1Vcw8ECompleteResponse:
      type: object
      properties:
        asset:
          type: object
          description: The finalized asset with status ready, src, dimensions, format, content_type, bytes, timestamps and possible rejected_reason.
    PostApiV1LinksDocumentRequest:
      type: object
      properties:
        title:
          type: string
        html:
          type: string
        figures:
          type: object
          properties:
            flow:
              type: object
              properties:
                mermaid:
                  type: string
                alt:
                  type: string
        source:
          type: object
          properties:
            kind:
              type: string
            ref:
              type: string
            rev:
              type: integer
            url:
              type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api