slideforge-dev Assets API

openapi: 3.2.0
info:
  title: SlideForge Assets 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: Assets
paths:
  /v1/assets/logo:
    post:
      tags:
      - Assets
      summary: Upload Logo Endpoint
      description: 'Upload a logo image for slide chrome injection.


        Accepts PNG, JPG, SVG, GIF, WebP. Max 5MB.

        Returns logo_id for use in generate requests.'
      operationId: upload_logo_endpoint_v1_assets_logo_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_logo_endpoint_v1_assets_logo_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/assets/image:
    post:
      tags:
      - Assets
      summary: Upload Image Endpoint
      description: 'Upload an image for use in the Image spec component.


        Accepts PNG, JPG, GIF, WebP, SVG. Max 10MB.

        Returns asset_id; place it on a slide as `image_src: "asset:"`.'
      operationId: upload_image_endpoint_v1_assets_image_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_image_endpoint_v1_assets_image_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/assets/{asset_id}:
    delete:
      tags:
      - Assets
      summary: Delete an uploaded image asset
      description: Delete a user-owned uploaded/generated image asset. Logos are content-addressed and shared by hash, so logo deletion is not exposed here.
      operationId: delete_asset_endpoint_v1_assets__asset_id__delete
      parameters:
      - name: asset_id
        in: path
        required: true
        schema:
          type: string
          title: Asset Id
      responses:
        '200':
          description: Asset deleted
          content:
            application/json:
              schema: {}
        '404':
          description: Asset not found or not owned by you
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/assets/image/generate:
    post:
      tags:
      - Assets
      summary: Generate Image Endpoint
      description: 'Generate an image via AI and store as a persistent asset.


        Wraps the existing generate_image() pipeline (used internally by creative mode)

        and returns an asset_id that the Image spec component can consume.


        Model selection precedence:

        1. Explicit `model` (gateway model ID) wins.

        2. Else `quality` (''draft'' | ''balanced'' | ''premium'') maps via QUALITY_TIER_MODELS.

        3. Else defaults to ''balanced'' (QUALITY_TIER_MODELS[''balanced'']).


        $0.05/generation (flat — independent of model tier for now).

        Size options: 1024x1024 (square), 1792x1024 (wide), 1024x1792 (tall).'
      operationId: generate_image_endpoint_v1_assets_image_generate_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageGenerateRequest'
        required: true
      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
    Body_upload_image_endpoint_v1_assets_image_post:
      properties:
        file:
          type: string
          format: binary
          title: File
      type: object
      required:
      - file
      title: Body_upload_image_endpoint_v1_assets_image_post
    ImageGenerateRequest:
      properties:
        prompt:
          type: string
          title: Prompt
        size:
          type: string
          title: Size
          default: 1024x1024
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
        quality:
          anyOf:
          - type: string
          - type: 'null'
          title: Quality
      type: object
      required:
      - prompt
      title: ImageGenerateRequest
    Body_upload_logo_endpoint_v1_assets_logo_post:
      properties:
        file:
          type: string
          format: binary
          title: File
      type: object
      required:
      - file
      title: Body_upload_logo_endpoint_v1_assets_logo_post
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  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.