slideforge-dev Referral API

openapi: 3.2.0
info:
  title: SlideForge Referral 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: Referral
paths:
  /v1/referral:
    get:
      tags:
      - Referral
      summary: Get your referral info
      description: Get your referral code, shareable link, and referral stats. Auto-generates a code if you don't have one yet.
      operationId: get_referral_v1_referral_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /v1/referral/code:
    put:
      tags:
      - Referral
      summary: Set custom referral code
      description: Set a custom referral code. 3-20 characters, alphanumeric and hyphens only. Case-insensitive (stored uppercase).
      operationId: set_referral_code_v1_referral_code_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetCodeRequest'
        required: true
      responses:
        '200':
          description: Code set successfully
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid code format
        '409':
          description: Code already taken
        '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
    SetCodeRequest:
      properties:
        code:
          type: string
          maxLength: 20
          minLength: 3
          title: Code
          description: Custom referral code (alphanumeric + hyphens)
      type: object
      required:
      - code
      title: SetCodeRequest
      description: PUT /v1/referral/code body.
  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.