sketchxflow-com Generate Html API

openapi: 3.2.0
info:
  title: SketchXFlow Generate Html API
  version: 0.1.0
tags:
- name: Generate Html
paths:
  /api/generate-html:
    post:
      summary: Generate Html Endpoint
      description: 'Generate a complete HTML page (Tailwind + Google Fonts) and render

        a screenshot. Streams SSE events compatible with the existing

        GenerationOverlay (project_created → agent_start/done → design_ready).


        The "design_ready" payload here carries an html_url + html_screenshot_url

        instead of an encrypted design_graph. Frontend''s preview iframe loads

        the HTML directly; the canvas is empty until Phase 3 (DOM-to-graph).'
      operationId: generate_html_endpoint_api_generate_html_post
      parameters:
      - name: x-team-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Team-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateHtmlRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Generate Html
components:
  schemas:
    BusinessFacts:
      properties:
        name:
          type: string
          maxLength: 120
          title: Name
          default: ''
        email:
          type: string
          maxLength: 160
          title: Email
          default: ''
        phone:
          type: string
          maxLength: 60
          title: Phone
          default: ''
        address:
          type: string
          maxLength: 300
          title: Address
          default: ''
        hours:
          type: string
          maxLength: 200
          title: Hours
          default: ''
      type: object
      title: BusinessFacts
      description: 'The real details a site shows (owner, 2026-09-29): given up front, they

        replace the "[Phone]" / "hello@[your-domain]" placeholders a generation

        otherwise leaves for the owner to fill before publishing.'
    GenerateHtmlRequest:
      properties:
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
        prompt:
          type: string
          maxLength: 30000
          minLength: 4
          title: Prompt
        platform:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
          default: web
        inspiration_url:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Inspiration Url
        use_design_research:
          type: boolean
          title: Use Design Research
          default: true
        ai_images:
          type: boolean
          title: Ai Images
          default: true
        image_model:
          anyOf:
          - type: string
          - type: 'null'
          title: Image Model
        reference_rights:
          type: boolean
          title: Reference Rights
          default: false
        business:
          anyOf:
          - $ref: '#/components/schemas/BusinessFacts'
          - type: 'null'
        design_reference:
          anyOf:
          - $ref: '#/components/schemas/DesignReferenceChoice'
          - type: 'null'
        style:
          anyOf:
          - type: string
          - type: 'null'
          title: Style
          default: auto
        enable_3d:
          type: boolean
          title: Enable 3D
          default: false
        build_3d:
          type: boolean
          title: Build 3D
          default: false
        cinematic_hero:
          type: boolean
          title: Cinematic Hero
          default: false
        logo_id:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Logo Id
        taste_sections:
          anyOf:
          - items:
              $ref: '#/components/schemas/TasteSection'
            type: array
            maxItems: 14
          - type: 'null'
          title: Taste Sections
        taste_css:
          anyOf:
          - type: string
            maxLength: 250000
          - type: 'null'
          title: Taste Css
      type: object
      required:
      - prompt
      title: GenerateHtmlRequest
      description: Body for /api/generate-html — Phase 1 of the HTML-first pipeline.
    DesignReferenceChoice:
      properties:
        image_url:
          type: string
          maxLength: 2000
          title: Image Url
        page_url:
          type: string
          maxLength: 2000
          title: Page Url
          default: ''
        title:
          type: string
          maxLength: 300
          title: Title
          default: ''
      type: object
      required:
      - image_url
      title: DesignReferenceChoice
      description: A reference look the user picked before building (/api/design-directions).
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    TasteSection:
      properties:
        slot:
          type: string
          maxLength: 40
          title: Slot
        id:
          type: string
          maxLength: 80
          title: Id
        name:
          type: string
          maxLength: 120
          title: Name
          default: ''
        html:
          type: string
          maxLength: 40000
          title: Html
      type: object
      required:
      - slot
      - id
      - html
      title: TasteSection
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError