supercompress-dev API

openapi: 3.1.0
info:
  title: supercompress-dev API
  version: '2026-10-31'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-31: 7 operation(s) read from 22 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; supercompress-dev has published no machine-readable contract
    that the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 2
    documentation: 5
    pages-with-code: 12
    pages-read: 22
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-31'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.supercompress.dev/api-reference
  - https://www.supercompress.dev/cut-llm-api-costs
  - https://docs.supercompress.dev/quickstart
  - https://docs.supercompress.dev/integrations
  - https://docs.supercompress.dev/usage
  - https://www.supercompress.dev/engine-v2-launch
  - https://www.supercompress.dev/faq
  - https://www.supercompress.dev/alternatives
  - https://www.supercompress.dev/alternatives/headroom
  - https://www.supercompress.dev/alternatives/caveman
  - https://www.supercompress.dev/token-compression
  - https://www.supercompress.dev/mcp-tool-output-compression
  - https://www.supercompress.dev/alternatives/caveman-cloud
  - https://www.supercompress.dev/alternatives/best-headroom-alternatives
  - https://www.supercompress.dev/alternatives/best-caveman-alternatives
  - https://www.supercompress.dev/alternatives/best-caveman-cloud-alternatives
  - https://www.supercompress.dev/supercompress-vs-llmlingua
  - https://www.supercompress.dev/what-is-context-compression-for-ai-agents
  - https://www.supercompress.dev/reduce-tool-call-output-tokens
  - https://www.supercompress.dev/llm-token-compression
  - https://www.supercompress.dev/llms.txt
  - https://www.supercompress.dev/llms-full.txt
servers:
- url: https://supercompress.dev
paths:
  /api/health:
    get:
      operationId: get_api_health
      tags:
      - Api
      summary: Service health check.
      x-source: https://www.supercompress.dev/llms-full.txt
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/mcp:
    get:
      operationId: get_api_mcp
      tags:
      - Api
      summary: 'Returns server metadata: name, version, transport, protocol version, auth methods and tool names.'
      x-source: https://www.supercompress.dev/llms-full.txt
      parameters:
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
        description: API key for authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_mcp
      tags:
      - Api
      summary: Hosted MCP server (JSON-RPC over Streamable HTTP).
      x-source: https://www.supercompress.dev/llms-full.txt
      parameters:
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
        description: API key for authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/usage:
    get:
      operationId: get_api_usage
      tags:
      - Api
      summary: Usage and quota for the account that owns the key.
      x-source: https://www.supercompress.dev/llms-full.txt
      parameters:
      - name: X-API-Key
        in: header
        required: true
        schema:
          type: string
        description: API key for authentication
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/compress:
    post:
      operationId: post_api_v1_compress
      tags:
      - Api
      summary: Send as JSON to compress context with query awareness.
      x-source: https://docs.supercompress.dev/api-reference
      parameters:
      - name: context
        in: query
        required: true
        schema:
          type: string
        description: The full context to compress. Supports Unicode, code, markup, logs.
      - name: query
        in: query
        required: true
        schema:
          type: string
        description: The user question that defines retention relevance.
      - name: budget_ratio
        in: query
        required: false
        schema:
          type: number
        description: Pass only for legacy fixed-ratio mode (0.1–1.0). Omit for default compiler mode.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1CompressRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1CompressResponse'
      x-evidence:
        kind: documentation
  /compress:
    get:
      operationId: get_compress
      tags:
      - Compress
      summary: GET /compress
      x-source: https://docs.supercompress.dev/api-reference
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCompressResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -d \"context=Your long text&query=What matters?\" https://supercompress.dev/compress  -H \"X-API-Key: sc_live_YOUR_KEY\"\
          \ \n POST request \n Send as JSON (standard) or form-encoded (simpler for curl). All three work: "
    post:
      operationId: post_compress
      tags:
      - Compress
      summary: POST /compress
      x-source: https://docs.supercompress.dev/api-reference
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCompressRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCompressResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://api.supercompress.dev/compress  -H \"X-API-Key: sc_live_YOUR_KEY\"  -H \"Content-Type: application/json\"\
          \  -d '{\"context\":\"…\",\"query\":\"…\"}' \n JSON and form-encoded POST both hit the same endpoint. Put the key in X-API-Key or Authorization:\
          \ Bearer , never in the query string. \n Parameters \n Parameter Type Required Description \n context string yes The full context to\
          \ compress. Suppo"
components:
  schemas:
    PostApiV1CompressRequest:
      type: object
      properties:
        context:
          type: string
          description: The full context to compress. Supports Unicode, code, markup, logs.
        query:
          type: string
          description: The user question that defines retention relevance.
        budget_ratio:
          type: number
          description: Pass only for legacy fixed-ratio mode (0.1–1.0). Omit for default compiler mode.
      required:
      - context
      - query
    PostApiV1CompressResponse:
      type: object
      properties:
        compressed_text:
          type: string
          description: The compressed context. Send this to your LLM.
        original_tokens:
          type: integer
          description: Input token count (rough estimate).
        kept_tokens:
          type: integer
          description: Tokens after compression.
        tokens_saved:
          type: integer
          description: original − kept.
        tokens_saved_pct:
          type: number
          description: Percent of prompt tokens removed.
        important_kept_pct:
          type: number
          description: Estimated fraction of important context preserved. 0.0–1.0.
        compression_risk:
          type: string
          description: '"low", "medium", or "high", verifier confidence.'
        kept_blocks:
          type: array
          description: Evidence blocks kept, with reasons.
        dropped_blocks:
          type: array
          description: Largest removed blocks, with reasons.
        policy_name:
          type: string
          description: '"SuperCompress-compiler" or "SuperCompress-fixed".'
    GetCompressResponse:
      type: object
      properties:
        compressed_text:
          type: string
        original_tokens:
          type: integer
        kept_tokens:
          type: integer
        tokens_saved:
          type: integer
        tokens_saved_pct:
          type: number
        important_kept_pct:
          type: number
        compression_risk:
          type: string
        kept_blocks:
          type: array
          items:
            type: object
            properties:
              heading:
                type: string
              reason:
                type: string
        dropped_blocks:
          type: array
          items:
            type: object
            properties:
              heading:
                type: string
              reason:
                type: string
        policy_name:
          type: string
    PostCompressRequest:
      type: object
      properties:
        context:
          type: string
        query:
          type: string
    PostCompressResponse:
      type: object
      properties:
        compressed_text:
          type: string
        original_tokens:
          type: integer
        kept_tokens:
          type: integer
        tokens_saved:
          type: integer
        tokens_saved_pct:
          type: number
        important_kept_pct:
          type: number
        compression_risk:
          type: string
        kept_blocks:
          type: array
          items:
            type: object
            properties:
              heading:
                type: string
              reason:
                type: string
        dropped_blocks:
          type: array
          items:
            type: object
            properties:
              heading:
                type: string
              reason:
                type: string
        policy_name:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
security:
- apiKey: []
tags:
- name: Api
- name: Compress