slideforge-dev Recipes API

openapi: 3.2.0
info:
  title: SlideForge Recipes 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: recipes
paths:
  /v1/recipes:
    get:
      tags:
      - recipes
      summary: List or semantically search composition recipes
      description: 'Returns the catalog of vetted composition patterns. Each recipe is a multi-component pattern (e.g. SplitView{Quadrant, List}) with audit-vetted ratios and a spec_json template ready to fill.


        Default: discovery-mode metadata. Pass `?detail=full` for the complete entry including spec_template + example_params + anti_patterns. Pass `?brief=` for hybrid (BM25 + vector + semantic) search against the slideforge-recipes-v1 index — returns ranked top-N with full recipe payloads.'
      operationId: list_recipes_endpoint_v1_recipes_get
      parameters:
      - name: detail
        in: query
        required: false
        schema:
          type: string
          description: '''compact'' (default) or ''full'''
          default: compact
          title: Detail
        description: '''compact'' (default) or ''full'''
      - name: shape
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by 00b shape
          title: Shape
        description: Filter by 00b shape
      - name: component
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter to recipes that use this component
          title: Component
        description: Filter to recipes that use this component
      - name: brief
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Natural language brief — runs hybrid semantic search
          title: Brief
        description: Natural language brief — runs hybrid semantic search
      - name: top
        in: query
        required: false
        schema:
          type: integer
          description: Result count for brief mode (max 20)
          default: 5
          title: Top
        description: Result count for brief mode (max 20)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/recipes/{slug}:
    get:
      tags:
      - recipes
      summary: Get a single recipe with spec template + example
      description: 'Returns the complete recipe: metadata + spec_template (JSON spec to copy and fill) + example_params (concrete values demonstrating the pattern) + anti_patterns (when NOT to use it).'
      operationId: get_recipe_endpoint_v1_recipes__slug__get
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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.