> ## 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.

# Create a render job

> Start rendering a quiz video. Returns 202 Accepted with a Location header for polling. Only one render per quiz can be in-flight at a time.



## OpenAPI

````yaml api-reference/openapi.json post /api/v1/renders
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/renders:
    post:
      tags:
        - Renders
      summary: Create a render job
      description: >-
        Start rendering a quiz video. Returns 202 Accepted with a Location
        header for polling. Only one render per quiz can be in-flight at a time.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRenderInput'
      responses:
        '202':
          description: Render job accepted
          headers:
            Location:
              schema:
                type: string
                description: URL to poll for render status
              required: true
              description: URL to poll for render status
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/RenderJob'
                required:
                  - data
        '404':
          description: Quiz not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Render already in progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - renders:write
components:
  schemas:
    CreateRenderInput:
      type: object
      properties:
        quiz_id:
          type: string
          format: uuid
          description: ID of the quiz to render
        format:
          type: string
          description: 'Output format (default: mp4)'
        resolution:
          type: string
          description: 'Output resolution (default: 1080p)'
      required:
        - quiz_id
    RenderJob:
      type: object
      properties:
        id:
          type: string
          format: uuid
        quiz_id:
          type: string
          format: uuid
        user_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - pending
            - claimed
            - rendering
            - done
            - failed
        output_url:
          type:
            - string
            - 'null'
        error_message:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - id
        - quiz_id
        - user_id
        - status
        - output_url
        - error_message
        - created_at
        - completed_at
    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.

````