snapforge-org API

openapi: 3.1.0
info:
  title: snapforge-org API
  version: '2026-10-31'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-31: 5 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; snapforge-org has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 4
    pages-with-code: 3
    pages-read: 3
  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: local
  x-sources:
  - https://api.snapforge.org
  - https://api.snapforge.org/examples/article.md
  - https://api.snapforge.org/llms.txt
servers:
- url: https://snapforge.org
paths:
  /signup:
    post:
      operationId: post_signup
      tags:
      - Signup
      summary: 'Body `{ "email": "you@example.com" }` → `{ apiKey, plan: "free", monthlyQuota: 100 }` (free = 100 renders, one-time free trial;
        `monthlyQuota` is a legacy field name, on the free plan it is a lifetime'
      x-source: https://api.snapforge.org/llms.txt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSignupRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostSignupResponse'
      x-evidence:
        kind: documentation
  /v1/markdown:
    post:
      operationId: post_v1_markdown
      tags:
      - Markdown
      summary: POST /v1/markdown
      x-source: https://api.snapforge.org
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1MarkdownRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1MarkdownResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://snapforge.org/v1/markdown  -H \"x-api-key: sf_...\"  -H \"content-type: application/json\"  -d '{\"url\"\
          : \"https://example.com\"}' # → clean Markdown for your LLM \n Why SnapForge \n \U0001F916 Markdown for LLMs Turn any web page into\
          \ clean, readable Markdown (article extraction built in). Feed live web content to your AI agents — no scraping, no HTML noise. \n \U0001F9FE\
          \ Invoices & reports Send your HTM"
  /v1/pdf:
    post:
      operationId: post_v1_pdf
      tags:
      - Pdf
      summary: POST /v1/pdf
      x-source: https://api.snapforge.org
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1PdfRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1PdfResponse'
      x-evidence:
        kind: documentation
  /v1/screenshot:
    post:
      operationId: post_v1_screenshot
      tags:
      - Screenshot
      summary: POST /v1/screenshot
      x-source: https://api.snapforge.org
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ScreenshotRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1ScreenshotResponse'
      x-evidence:
        kind: documentation
  /v1/usage:
    get:
      operationId: get_v1_usage
      tags:
      - Usage
      summary: GET /v1/usage
      x-source: https://api.snapforge.org
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1UsageResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostSignupRequest:
      type: object
      properties:
        email:
          type: string
      required:
      - email
    PostSignupResponse:
      type: object
      properties:
        apiKey:
          type: string
        plan:
          type: string
          description: '"free"'
        monthlyQuota:
          type: integer
          description: '100'
    PostV1MarkdownRequest:
      type: object
      properties:
        url:
          type: string
    PostV1MarkdownResponse:
      type: object
      properties:
        html:
          type: string
        singlePage:
          type: boolean
        pageFormat:
          type: string
        landscape:
          type: boolean
        margin:
          type: string
        printBackground:
          type: boolean
    PostV1PdfRequest:
      type: object
      properties:
        html:
          type: string
          description: 'or "url": "https://..."'
        url:
          type: string
          description: 'or "html": "<h1>Invoice #42</h1>"'
        singlePage:
          type: boolean
          description: true = one tall page fit to content (no pagination)
        pageFormat:
          type: string
          description: A0–A6, Letter, Legal, Tabloid
        landscape:
          type: boolean
        margin:
          type: string
        printBackground:
          type: boolean
    PostV1PdfResponse:
      type: object
      properties:
        binary PDF:
          type: string
          description: Returns the binary PDF.
    PostV1ScreenshotRequest:
      type: object
      properties:
        url:
          type: string
          description: 'or "html": "<h1>Hi</h1>"'
        html:
          type: string
          description: 'or "url": "https://example.com"'
        width:
          type: integer
          description: viewport width (100–3840)
        height:
          type: integer
          description: viewport height (100–2160)
        fullPage:
          type: boolean
          description: whole page (default); false = viewport only
        format:
          type: string
          description: png | jpeg
        quality:
          type: integer
          description: jpeg only
        scale:
          type: integer
          description: deviceScaleFactor 1–3
        delay:
          type: integer
          description: extra ms to wait (max 10000)
        waitUntil:
          type: string
          description: load | networkidle
    PostV1ScreenshotResponse:
      type: object
      properties:
        binary image:
          type: string
          description: Returns the binary image. Response headers expose x-quota-used / x-quota-limit.
    GetV1UsageResponse:
      type: object
      properties:
        plan:
          type: object
          description: Your plan information.
        usage:
          type: object
          description: Usage details.
        quota:
          type: object
          description: Quota information as JSON (total used on the free trial, current month on paid plans).
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
security:
- apiKey: []
tags:
- name: Markdown
- name: Pdf
- name: Screenshot
- name: Signup
- name: Usage