> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quiz-quail.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate promotion suggestions

> Use AI to generate promotion suggestions for a quiz (platform recommendations, timing, SEO, and enhanced metadata). Returns a Server-Sent Events stream. Results are cached per quiz.



## OpenAPI

````yaml api-reference/openapi.json post /api/v1/promote
openapi: 3.1.0
info:
  title: Quiz Quail API
  version: 1.0.0
  description: >-
    The Quiz Quail API lets you create, manage, and render quiz videos
    programmatically. Build quizzes with multiple rounds and question types,
    apply custom themes, render to video, upload to YouTube, and use AI to
    generate quizzes from topics.


    ## Authentication


    All endpoints require a Bearer token (API key). Include it in the
    `Authorization` header:


    ```

    Authorization: Bearer qq_your_api_key_here

    ```


    API keys can be scoped to specific permissions. See the security schemes
    below for available scopes.


    ## Rate Limiting


    Requests are rate-limited per user:

    - **Read** endpoints: 300 requests/minute

    - **Write** endpoints: 30 requests/minute

    - **AI** endpoints: 5 requests/minute

    - **Render** endpoints: 10 requests/hour


    Rate limit headers are included in every response.


    ## Pagination


    List endpoints use cursor-based pagination. Pass the `cursor` from the
    previous response to get the next page. The `hasMore` field indicates
    whether more items exist.


    ## Errors


    Errors follow [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457). Every error response
    includes `type`, `title`, `status`, and `detail` fields.
  contact:
    name: Quiz Quail
    url: https://quizquail.com
servers:
  - url: https://quizquail.com
    description: Production
  - url: http://localhost:3000
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Quizzes
    description: Create and manage quizzes, rounds, and questions
  - name: Themes
    description: Create and manage visual themes for quizzes
  - name: Media
    description: Upload, manage, and search media files
  - name: Renders
    description: Render quizzes to video and download results
  - name: Thumbnails
    description: Generate video thumbnails
  - name: YouTube
    description: Upload videos to YouTube and manage uploads
  - name: Webhooks
    description: Register webhooks for event notifications
  - name: AI
    description: AI-powered quiz generation and promotion suggestions
  - name: Trends
    description: Trending topics for quiz inspiration
paths:
  /api/v1/promote:
    post:
      tags:
        - AI
      summary: Generate promotion suggestions
      description: >-
        Use AI to generate promotion suggestions for a quiz (platform
        recommendations, timing, SEO, and enhanced metadata). Returns a
        Server-Sent Events stream. Results are cached per quiz.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PromoteInput'
      responses:
        '200':
          description: SSE stream of promotion generation progress
          content:
            text/event-stream:
              schema:
                type: string
                description: Server-Sent Events stream
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Quiz not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - ai:write
components:
  schemas:
    PromoteInput:
      type: object
      properties:
        quizId:
          type: string
          minLength: 1
        force:
          type: boolean
          default: false
          description: Force regeneration even if cached suggestions exist
      required:
        - quizId
    Error:
      type: object
      properties:
        type:
          type: string
          example: https://quizquail.com/problems/validation-error
        title:
          type: string
          example: Validation Error
        status:
          type: integer
          example: 400
        detail:
          type: string
          example: Request validation failed
        instance:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
      required:
        - type
        - title
        - status
    FieldError:
      type: object
      properties:
        field:
          type: string
          example: title
        message:
          type: string
          example: Title is required
        code:
          type: string
          example: too_small
      required:
        - field
        - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API key authentication. Prefix your key with `Bearer ` in the
        Authorization header.


        Keys follow the format `qq_...` and can be scoped to specific
        permissions.

````