slideforge-dev Render API

openapi: 3.2.0
info:
  title: SlideForge Render API
  description: 'Agent-first PowerPoint generation. Send structured slide intents (a `form` plus typed fields) or a brief; get back a real, editable `.pptx`. The draw path is deterministic — no model renders your slide, so supplied numbers and text come out verbatim. Every response carries `status`, `fidelity` and `warnings` so an automated caller can tell whether the output is usable. $0.05 per slide; an unusable slide is not billed. Authenticate with a SlideForge API key (`Authorization: Bearer sf_live_…` or `X-API-Key`) — new accounts include 60 free slides, no credit card: https://slideforge.dev/sign-up'
  version: 5.356.0
servers:
- url: https://api.slideforge.dev
security:
- bearerAuth: []
- apiKeyAuth: []
tags:
- name: render
paths:
  /v1/render:
    post:
      tags:
      - render
      summary: Removed — the template render engine is gone
      description: Gone (410). The template render engine was removed. Discover slide forms via the MCP browse_catalog tool (form/variant catalog; type=schema + family for the machine-readable contract), then render via POST /v1/render/auto with a brief or a structured intent via the MCP create_slide tool. Caller-supplied python-pptx code renders via POST /v1/render/code.
      operationId: render_slide_removed_v1_render_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '410':
          description: Templates removed
  /v1/render/auto:
    post:
      tags:
      - render
      summary: Render a slide from a brief via the SSG intent engine ($0.05)
      description: Brief → SSG intent route → deterministic render. The brief path used by MCP `create_slide` when only a prose brief is supplied. $0.05 per slide. Unroutable briefs return a 422 `intent_unroutable` error with no charge. Explicit style asks in the brief (dark/light, corporate/technical/... looks) map onto built-in themes automatically unless `theme_id` is set; the response names the mapping and any unsupported styling.
      operationId: render_auto_endpoint_v1_render_auto_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutoRenderRequest'
        required: true
      responses:
        '200':
          description: Render complete
          content:
            application/json:
              schema: {}
        '400':
          description: Missing or empty brief
        '402':
          description: Insufficient balance
        '422':
          description: Intent could not be routed — no charge
        '429':
          description: Rate limit exceeded
  /v1/render/intent:
    post:
      tags:
      - render
      summary: Render a slide from a structured SSG intent (mirrors MCP create_slide)
      description: 'Deterministic SSG render from a structured intent — the REST mirror of the MCP create_slide tool. Provide ONE of: `form` (+ typed content fields) for a typed intent, `prior_id` (+`content`) to render an exact catalog prior (no routing), `author_ssg` for a full AuthorSSG document, or a prose `brief`. $0.05 per slide.


        `preview:true` → a FREE ephemeral PNG preview (no job, no charge, nothing downloadable). Eligible only for verbatim inputs (`prior_id`/`author_ssg`); briefs/images return 400 (use Generate).


        Brief-mode style asks (dark/light, look adjectives) auto-map onto built-in themes unless `theme_id` is set — pick one explicitly via GET /v1/brands or browse_catalog(type=themes).'
      operationId: render_intent_endpoint_v1_render_intent_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntentRenderRequest'
        required: true
      responses:
        '200':
          description: Render complete (or free PNG preview)
          content:
            application/json:
              schema: {}
        '400':
          description: Missing input, or preview not eligible (use Generate)
        '402':
          description: Insufficient balance
        '422':
          description: Intent could not be rendered — no charge
  /v1/render/intent/deck:
    post:
      tags:
      - render
      summary: Render a deck from N structured SSG intents (mirrors MCP create_deck)
      description: 'Deterministic SSG deck render — the REST mirror of the MCP create_deck tool. `slides` is a list of 1-30 intent objects (each the same shape as /v1/render/intent: form + typed fields, or a brief). Slides fill in parallel and merge into one themed PPTX. $0.05 per usable slide.'
      operationId: render_intent_deck_endpoint_v1_render_intent_deck_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntentDeckRequest'
        required: true
      responses:
        '200':
          description: Deck render complete
          content:
            application/json:
              schema: {}
        '400':
          description: Missing/invalid slides
        '402':
          description: Insufficient balance
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/render/from-image:
    post:
      tags:
      - render
      summary: 'Ingest: image → editable slide(s) (alias of /v1/perception/proceed)'
      description: Canonical ingest name for image → slide(s); thin delegate to the planner_v2 from-image pipeline.
      operationId: render_from_image_endpoint_v1_render_from_image_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProceedRequest'
        required: true
      responses:
        '200':
          description: Render complete
          content:
            application/json:
              schema: {}
        '400':
          description: Missing image or invalid choices
        '402':
          description: Insufficient balance
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/render/recipe:
    post:
      tags:
      - render
      summary: Removed — the semantic recipe engine is gone
      description: Gone (410). The semantic recipe engine was removed in v5. Send a structured intent via the MCP create_slide tool, or use POST /v1/render/auto.
      operationId: render_recipe_endpoint_v1_render_recipe_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '410':
          description: Recipe engine removed
  /v1/suggest-layout:
    post:
      tags:
      - render
      summary: Removed — layout suggestion is gone (ADR 2026-06-13)
      description: Gone (410). The brief→spec suggestion helper was retired with the spec endpoint. Use POST /v1/render/auto (brief) or POST /v1/render/intent (structured intent).
      operationId: suggest_layout_endpoint_v1_suggest_layout_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '410':
          description: suggest-layout removed
  /v1/render/preflight:
    post:
      tags:
      - render
      summary: Removed — template preflight is gone
      description: Gone (410). The template render engine was removed. Discover slide forms via the MCP browse_catalog tool (form/variant catalog; type=schema + family for the machine-readable contract), then render via POST /v1/render/auto with a brief or a structured intent via the MCP create_slide tool. Caller-supplied python-pptx code renders via POST /v1/render/code.
      operationId: render_preflight_removed_v1_render_preflight_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '410':
          description: Templates removed
  /v1/render/intent/deck/{deck_id}:
    patch:
      tags:
      - render
      summary: Edit slides of a rendered deck (free, no model)
      operationId: edit_intent_deck_v1_render_intent_deck__deck_id__patch
      parameters:
      - name: deck_id
        in: path
        required: true
        schema:
          type: string
          title: Deck Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeckEditRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/render/intent/{job_id}:
    patch:
      tags:
      - render
      summary: Edit a rendered slide (free, no model)
      operationId: edit_intent_slide_v1_render_intent__job_id__patch
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SlideEditRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    DeckSlideEdit:
      properties:
        slide:
          type: integer
          minimum: 0.0
          title: Slide
          description: 0-based index, as slides[].i in the deck response
        patch:
          type: object
          title: Patch
          description: the slide fields to change (same fields as create_slide). A field left out keeps its value, a field sent as null is removed, a list replaces the whole list, `data` merges key by key. Send only `notes` to add or replace speaker notes without a re-render.
      type: object
      required:
      - slide
      - patch
      title: DeckSlideEdit
    ProceedRequest:
      properties:
        image:
          type: string
          title: Image
        instructions:
          anyOf:
          - type: string
          - type: 'null'
          title: Instructions
        theme_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Theme Id
        brand:
          anyOf:
          - type: object
          - type: 'null'
          title: Brand
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        source:
          anyOf:
          - type: string
          - type: 'null'
          title: Source
        selected_option_id:
          anyOf:
          - type: string
            enum:
            - preserve_slide
            - explain_slide
            - teach_deck
            - reconstruct_slide
          - type: 'null'
          title: Selected Option Id
        mode:
          type: string
          title: Mode
          default: auto
        choices:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Choices
        allow_image_generation:
          type: boolean
          title: Allow Image Generation
          default: true
        verify:
          type: boolean
          title: Verify
          default: true
      type: object
      required:
      - image
      title: ProceedRequest
    DeckEditRequest:
      properties:
        slides:
          items:
            $ref: '#/components/schemas/DeckSlideEdit'
          type: array
          minItems: 1
          title: Slides
      type: object
      required:
      - slides
      title: DeckEditRequest
    IntentRenderRequest:
      properties:
        brief:
          anyOf:
          - type: string
          - type: 'null'
          title: Brief
        form:
          anyOf:
          - type: string
          - type: 'null'
          title: Form
        variant:
          anyOf:
          - type: string
          - type: 'null'
          title: Variant
        prior_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Prior Id
        content:
          anyOf:
          - type: object
          - type: 'null'
          title: Content
        author_ssg:
          anyOf:
          - type: object
          - type: 'null'
          title: Author Ssg
        headline:
          anyOf:
          - type: string
          - type: 'null'
          title: Headline
        context:
          anyOf:
          - type: string
          - type: 'null'
          title: Context
        subject:
          anyOf:
          - type: string
          - type: 'null'
          title: Subject
        takeaway:
          anyOf:
          - type: string
          - type: 'null'
          title: Takeaway
        caution:
          anyOf:
          - type: string
          - type: 'null'
          title: Caution
        highlight:
          anyOf:
          - type: string
          - type: 'null'
          title: Highlight
        source_note:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Note
        date:
          anyOf:
          - type: string
          - type: 'null'
          title: Date
        notes:
          anyOf:
          - type: string
          - type: 'null'
          title: Notes
        form_description:
          anyOf:
          - type: string
          - type: 'null'
          title: Form Description
        density:
          anyOf:
          - type: string
          - type: 'null'
          title: Density
        direction:
          anyOf:
          - type: string
            enum:
            - ltr
            - rtl
          - type: 'null'
          title: Direction
        blocks:
          anyOf:
          - items: {}
            type: array
          - type: 'null'
          title: Blocks
        metric:
          anyOf:
          - type: object
          - type: 'null'
          title: Metric
        data:
          anyOf:
          - type: object
          - type: 'null'
          title: Data
        image_src:
          anyOf:
          - type: string
          - type: 'null'
          title: Image Src
        image_prompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Image Prompt
        auto_decompose:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Auto Decompose
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        theme_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Theme Id
        brand:
          anyOf:
          - type: object
          - type: 'null'
          title: Brand
        source:
          anyOf:
          - type: string
          - type: 'null'
          title: Source
        preview:
          type: boolean
          title: Preview
          default: false
        detail:
          anyOf:
          - type: string
          - type: 'null'
          title: Detail
        allow_fabrication:
          type: boolean
          title: Allow Fabrication
          default: false
        allow_low_confidence:
          type: boolean
          title: Allow Low Confidence
          default: false
        allow_truncation:
          type: boolean
          title: Allow Truncation
          default: false
        dry_run:
          type: boolean
          title: Dry Run
          default: false
        quality_profile:
          anyOf:
          - type: string
          - type: 'null'
          title: Quality Profile
        variant_policy:
          anyOf:
          - type: string
          - type: 'null'
          title: Variant Policy
        allow_variant_fallback:
          type: boolean
          title: Allow Variant Fallback
          default: false
        min_font_pt:
          anyOf:
          - type: number
          - type: 'null'
          title: Min Font Pt
        imagery:
          anyOf:
          - type: string
          - type: 'null'
          title: Imagery
        imagery_tag:
          anyOf:
          - type: string
          - type: 'null'
          title: Imagery Tag
        styling:
          anyOf:
          - type: string
          - type: 'null'
          title: Styling
        verify:
          anyOf:
          - type: string
          - type: 'null'
          title: Verify
      additionalProperties: true
      type: object
      title: IntentRenderRequest
      description: 'POST /v1/render/intent — structured SSG intent → deterministic render.


        The REST mirror of the MCP create_slide intent surface (the `_INTENT_FIELDS`

        allowlist in api/app/routers/ssg_v2.py). Provide a prose `brief`, a typed

        structured intent (`form` + the content slots below), an exact catalog prior

        (`prior_id` + `content`), or a full `author_ssg` document. $0.05 per slide.

        (A free PNG preview path is a follow-on per ADR-2026-06-13, built with the web

        themes/playground work.)'
    AutoRenderRequest:
      properties:
        brief:
          type: string
          title: Brief
        theme_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Theme Id
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        expand_brief:
          type: boolean
          title: Expand Brief
          default: false
        data_hint:
          anyOf:
          - type: object
          - type: 'null'
          title: Data Hint
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        chrome:
          anyOf:
          - $ref: '#/components/schemas/Chrome'
          - type: 'null'
        include_preview:
          type: boolean
          title: Include Preview
          default: true
        source:
          anyOf:
          - type: string
          - type: 'null'
          title: Source
        allow_fabrication:
          type: boolean
          title: Allow Fabrication
          default: false
        allow_low_confidence:
          type: boolean
          title: Allow Low Confidence
          default: false
        allow_truncation:
          type: boolean
          title: Allow Truncation
          default: false
        dry_run:
          type: boolean
          title: Dry Run
          default: false
        styling:
          anyOf:
          - type: string
          - type: 'null'
          title: Styling
      type: object
      required:
      - brief
      title: AutoRenderRequest
      description: 'POST /v1/render/auto request body — brief → SSG intent render.


        The brief path: SSG intent route → deterministic render. $0.05 per slide;

        unroutable briefs return 422 with no charge.'
    Chrome:
      properties:
        title:
          anyOf:
          - type: string
          - type: 'null'
          title: Title
        subtitle:
          anyOf:
          - type: string
          - type: 'null'
          title: Subtitle
        kicker:
          anyOf:
          - type: string
          - type: 'null'
          title: Kicker
        footer:
          anyOf:
          - type: string
          - type: 'null'
          title: Footer
        source:
          anyOf:
          - type: string
          - type: 'null'
          title: Source
        page_number:
          anyOf:
          - type: integer
          - type: 'null'
          title: Page Number
        classification:
          anyOf:
          - type: string
          - type: 'null'
          title: Classification
      type: object
      title: Chrome
      description: 'Slide chrome — the frame rendered by render_chrome().


        All fields optional. Resolution order:

        1. Explicit chrome on request (highest priority)

        2. LLM-extracted chrome from brief

        3. Deck-level chrome defaults

        4. Theme chrome defaults

        5. Not rendered (if still None)'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    IntentDeckRequest:
      properties:
        slides:
          items:
            type: object
          type: array
          title: Slides
          default: []
        theme_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Theme Id
        brand:
          anyOf:
          - type: object
          - type: 'null'
          title: Brand
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        source:
          anyOf:
          - type: string
          - type: 'null'
          title: Source
        dry_run:
          type: boolean
          title: Dry Run
          default: false
        force_render:
          type: boolean
          title: Force Render
          default: false
        allow_partial:
          type: boolean
          title: Allow Partial
          default: false
        logo_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Logo Id
        styling:
          anyOf:
          - type: string
          - type: 'null'
          title: Styling
        direction:
          anyOf:
          - type: string
            enum:
            - ltr
            - rtl
          - type: 'null'
          title: Direction
        imagery:
          anyOf:
          - type: string
          - type: 'null'
          title: Imagery
        imagery_tag:
          anyOf:
          - type: string
          - type: 'null'
          title: Imagery Tag
        strict_policy:
          anyOf:
          - type: object
          - type: 'null'
          title: Strict Policy
        detail:
          anyOf:
          - type: string
          - type: 'null'
          title: Detail
      type: object
      title: IntentDeckRequest
      description: 'POST /v1/render/intent/deck — N structured SSG intents → one merged PPTX.


        REST mirror of the MCP create_deck intent path. `slides` is a list of intent objects

        (same shape as /v1/render/intent: form + typed fields, or a brief). Slides fill in

        parallel and merge into one themed deck. $0.05 per usable slide.'
    SlideEditRequest:
      properties:
        patch:
          type: object
          title: Patch
          description: the slide fields to change (same fields as create_slide). A field left out keeps its value, a field sent as null is removed, a list replaces the whole list, `data` merges key by key. Send only `notes` to add or replace speaker notes without a re-render.
      type: object
      required:
      - patch
      title: SlideEditRequest
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'SlideForge API key: `Authorization: Bearer sf_live_…`. Create one at https://slideforge.dev/console/keys'
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Same key, header form — for clients that cannot set Authorization.