slideforge-dev Analyze API

openapi: 3.2.0
info:
  title: SlideForge Analyze 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: Analyze
paths:
  /v1/analyze/image/perceive:
    post:
      tags:
      - Analyze
      summary: Vision perception → SlideIntentIR (v0.1, prototype)
      description: 'Run full vision perception (4 parallel vision-model specialists) and

        return a SlideIntentIR structured spec. Phase 2 of the

        Perception → Planner v2 plan.


        Bills `image_analysis_v2` ($0.20) on success only. The returned

        `SlideIntentIR` is the input the Planner v2 will consume (P4).

        Today, callers can also drive it through the legacy auto-router by

        extracting `brief = perception.brief()` (helper TBD).


        INTERNAL ENDPOINT — perception schema is IP-load-bearing and not

        advertised in the public MCP surface. Keep on this REST path until

        we decide otherwise.'
      operationId: perceive_image_endpoint_v1_analyze_image_perceive_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Missing or invalid image
        '402':
          description: Insufficient balance
        '500':
          description: Vision perception failed
  /v1/analyze/image/preflight:
    post:
      tags:
      - Analyze
      summary: Estimate cost+duration before running full image analysis
      description: 'Run a single cheap vision pass to estimate the cost+duration of the

        full from-image flow. Free to the user; we eat ~$0.02/call internally.


        The frontend uses this output to render a "Will cost $X-Y, balance $Z.

        Proceed?" confirmation before committing to the expensive perception

        path. Auto-mode can skip the confirmation; customize-mode shows

        per-asset choices once we have asset-level data (P2).'
      operationId: preflight_image_endpoint_v1_analyze_image_preflight_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Missing or invalid image
        '500':
          description: Vision-model preflight failed
  /v1/analyze/image:
    post:
      tags:
      - Analyze
      summary: Analyze Image Endpoint
      description: 'Analyze an uploaded image and return a synthesized slide brief.


        Sync. Bills `image_analysis` ($0.05) on success only. Feed the returned

        `brief` into POST /v1/render/auto to produce a slide.


        For multi-slide breakdowns (`slide_count > 1`) returns

        `AnalyzeImageMultiResponse` with one entry per slide; the agent then

        calls /v1/render/auto once per slide and assembles a deck.'
      operationId: analyze_image_endpoint_v1_analyze_image_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnalyzeImageRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '400':
          description: Missing or invalid image
        '402':
          description: Insufficient balance
        '500':
          description: Vision-model analysis failed
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AnalyzeImageRequest:
      properties:
        image:
          type: string
          title: Image
        instructions:
          anyOf:
          - type: string
          - type: 'null'
          title: Instructions
        slide_count:
          type: integer
          title: Slide Count
          default: 1
      type: object
      required:
      - image
      title: AnalyzeImageRequest
      description: 'POST /v1/analyze/image request body — vision LLM analyzes an image and

        synthesizes a slide brief.


        Sync. Bills against the wallet on success ($0.05 per call). Feed the

        returned `brief` to POST /v1/render/auto (or any other endpoint that

        takes a brief). Decoupled from rendering so agents can analyze without

        committing to a render — and so the from-image UX is two visible stages

        (Analyzing → Rendering) instead of one opaque "generate" call.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  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.