API Documentation

Getting started

Authentication

Every documented public endpoint accepts the same key. Resources are always scoped to the authenticated owner.

Authorization: Bearer qqm_live_REPLACE_WITH_YOUR_KEY
Content-Type: application/json

Generation

Endpoint limit: 20 requests per minute.

Quick mode

Quick mode covers common settings without requiring a complete Studio snapshot.

curl --request POST "https://www.quickquotemaker.com/api/studio/generate" \
  --header "Authorization: Bearer qqm_live_REPLACE_WITH_YOUR_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "mode": "quick",
    "name": "Daily inspiration",
    "quick": {
      "text": "The future depends on what you do today.",
      "author": "Mahatma Gandhi",
      "ratio": "instagramPost",
      "fontFamily": "Playfair Display",
      "textColor": "#ffffff",
      "align": "center",
      "quoteMark": "curly",
      "bold": true,
      "background": {
        "type": "gradient",
        "from": "#0f172a",
        "to": "#2563eb"
      }
    }
  }'

Snapshot mode

Snapshot mode accepts the complete Quote Studio design: independent typography for all three text areas, background, filters, overlay, border, shadows, text boxes, transforms, positions, and watermarks.

{
  "mode": "snapshot",
  "name": "Story campaign",
  "design": {
    "quote": "Build something worth sharing.",
    "author": "QuickQuoteMaker",
    "freeText": "@yourbrand",
    "ratio": "tiktok",
    "bgMode": "image",
    "overlayOn": true,
    "overlayColor": "#020617",
    "overlayOpacity": 45,
    "fontFamily": "Comfortaa",
    "fontSize": 68,
    "textColor": "#ffffff",
    "align": "center",
    "bold": true,
    "watermarkTextOn": true,
    "watermarkText": "quickquotemaker.com"
  },
  "backgroundUrl": "https://images.example.com/background.jpg",
  "record": true
}

backgroundUrl overrides the image in design. Omitted fields use the Studio’s normalized defaults.

Video background

A public HTTPS video URL produces a silent MP4 with Studio text, filters, overlay, watermarks, and border.

{
  "mode": "snapshot",
  "design": {
    "quote": "Motion makes the message visible.",
    "author": "QuickQuoteMaker",
    "ratio": "instagramStory",
    "bgMode": "video"
  },
  "videoUrl": "https://cdn.example.com/background.mp4",
  "durationSeconds": 8,
  "record": true
}

• Source video: 50 MB maximum.
• Duration: 2–15 seconds, default 6 seconds.
• videoUrl overrides every other background.
• The output contains no audio track.

Collections

curl --request POST "https://www.quickquotemaker.com/api/collections" \
  --header "Authorization: Bearer qqm_live_REPLACE_WITH_YOUR_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "title": "Daily inspiration",
    "slides": [{
      "id": "slide-1",
      "durationSeconds": 2.5,
      "transition": "slide",
      "design": {
        "snapshot": {
          "quote": "Begin with one clear step.",
          "ratio": "tiktok"
        },
        "videoUrl": "https://cdn.example.com/background.mp4",
        "posterUrl": "https://cdn.example.com/poster.jpg",
        "startSeconds": 1.5,
        "marker": false,
        "bgMode": "video"
      }
    }]
  }'

• Maximum 60 slides per collection.
• durationSeconds: 1–30. Fractional values are accepted, for example 2.5.
• transition: fade, slide, zoom, cut.
• design.bgMode: gradient, solid, image, video.
• Video background: set design.videoUrl and design.posterUrl.
• design.startSeconds: 0–3600. Offsets where the clip starts, to skip a weak opening. Ignored unless the background is a video.
• design.marker: boolean. Flags a pattern-interrupt card (TOP 10, TOP 5): its title punches in harder than a normal slide.
• Titles are unique per user, ignoring case and redundant whitespace.
• A duplicate title returns HTTP 409 with collection_title_duplicate.

Reference

Available formats

Generation response

{
  "id": "f3f0ea51-086d-4bc2-8f63-5c63e73db902",
  "url": "https://PROJECT.supabase.co/storage/v1/object/public/downloaded-images/ID.png",
  "width": 1080,
  "height": 1080,
  "format": "PNG"
}

Global rate limiting

Limited responses use HTTP 429 and include Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.

Errors

In production, error responses only carry the error field. Internal details (database message, code, and hint) are stripped and stay in the server logs.

What’s new