Freepik Video Upscaler API

openapi: 3.2.0
info:
  description: The Magnific API is your gateway to a vast collection of high-quality digital resources for your applications and projects. As a leading platform, it offers a wide range of graphics, including vectors, photos, illustrations, icons, PSD templates, and more, all curated by talented designers from around the world.
  title: Magnific Video Upscaler API
  version: 1.0.0
servers:
- description: B2B API Production V1
  url: https://api.magnific.com
security:
- magnificApiKey: []
tags:
- name: video-upscaler
paths:
  /v1/ai/video-upscaler:
    get:
      description: Returns a list of all video upscaler tasks. Each task includes its ID, current status, and output URL if completed.
      operationId: getAiVideoUpscalerTasks
      responses:
        '200':
          $ref: '#/components/responses/task-list-200-default-response'
        '400':
          $ref: '#/components/responses/400-bad-request'
        '401':
          $ref: '#/components/responses/401-unauthorized'
        '500':
          $ref: '#/components/responses/500-internal-server-error'
        '503':
          $ref: '#/components/responses/503-service-unavailable'
      summary: Video Upscaler - List tasks
      tags:
      - video-upscaler
    post:
      description: 'Upscales a video while enhancing visual quality and resolution.

        Supports various output resolutions (720p, 1k, 2k, 4k) with optional creativity, sharpening, and grain controls.'
      operationId: postAiVideoUpscaler
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request-content_4'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/task-detail-200-default-response'
        '400':
          $ref: '#/components/responses/400-bad-request'
        '401':
          $ref: '#/components/responses/401-unauthorized'
        '500':
          $ref: '#/components/responses/500-internal-server-error'
        '503':
          $ref: '#/components/responses/503-service-unavailable'
      summary: Video Upscaler - Upscale video
      tags:
      - video-upscaler
  /v1/ai/video-upscaler/{task-id}:
    get:
      description: Returns the current status and output URL of a specific video upscaler task. The output URL is included only if the task has completed successfully.
      operationId: getAiVideoUpscalerTask
      parameters:
      - description: ID of the task
        in: path
        name: task-id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          $ref: '#/components/responses/task-detail-200-default-response'
        '400':
          $ref: '#/components/responses/400-bad-request'
        '401':
          $ref: '#/components/responses/401-unauthorized'
        '500':
          $ref: '#/components/responses/500-internal-server-error'
        '503':
          $ref: '#/components/responses/503-service-unavailable'
      summary: Video Upscaler - Get task status
      tags:
      - video-upscaler
  /v1/ai/video-upscaler/turbo:
    post:
      description: 'Upscales a video using turbo processing with premium quality enhancement applied automatically.

        Turbo mode reduces processing time while maintaining high visual quality.

        Supports various output resolutions (720p, 1k, 2k, 4k) with optional creativity, sharpening, and grain controls.'
      operationId: postAiVideoUpscalerTurbo
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request-content_4'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/task-detail-200-default-response'
        '400':
          $ref: '#/components/responses/400-bad-request'
        '401':
          $ref: '#/components/responses/401-unauthorized'
        '500':
          $ref: '#/components/responses/500-internal-server-error'
        '503':
          $ref: '#/components/responses/503-service-unavailable'
      summary: Video Upscaler Turbo - Upscale video
      tags:
      - video-upscaler
components:
  schemas:
    inline_object_4:
      example:
        data:
          generated:
          - https://openapi-generator.tech
          - https://openapi-generator.tech
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: CREATED
      properties:
        data:
          $ref: '#/components/schemas/task-detail_1'
      required:
      - data
      type: object
    inline_object_1_problem_invalid_params_inner:
      properties:
        name:
          description: Name of the invalid parameter.
          example: page
          type: string
        field:
          description: Field of the invalid parameter. Mirrors `name`.
          example: page
          type: string
        reason:
          example: Parameter 'page' must be greater than 0
          type: string
      required:
      - field
      - name
      - reason
      type: object
    flavor_1:
      default: vivid
      description: 'Video processing flavor that determines the upscaling style:

        - `vivid`: Enhanced colors and contrast for more vibrant output

        - `natural`: Preserves original colors and natural appearance

        '
      enum:
      - vivid
      - natural
      type: string
    task:
      example:
        task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        status: CREATED
      properties:
        task_id:
          description: Task identifier
          format: uuid
          type: string
        status:
          description: Task status
          enum:
          - CREATED
          - IN_PROGRESS
          - COMPLETED
          - FAILED
          type: string
      required:
      - status
      - task_id
      type: object
    resolution_1:
      default: 2k
      description: 'Output resolution for the video upscaling:

        - `720p`: HD output

        - `1k`: Standard definition output

        - `2k`: High definition output (default)

        - `4k`: Ultra high definition output

        '
      enum:
      - 720p
      - 1k
      - 2k
      - 4k
      type: string
    inline_object_1:
      properties:
        problem:
          $ref: '#/components/schemas/inline_object_1_problem'
      type: object
    inline_object_1_problem:
      properties:
        message:
          example: Validation error
          type: string
        invalid_params:
          items:
            $ref: '#/components/schemas/inline_object_1_problem_invalid_params_inner'
          type: array
      required:
      - invalid_params
      - message
      type: object
    inline_object_2:
      example:
        message: Internal Server Error
      properties:
        message:
          example: Internal Server Error
          type: string
      type: object
    request-content_4:
      properties:
        video:
          description: 'Source video to upscale. Must be a publicly accessible HTTPS URL pointing to the video.

            '
          type: string
        creativity:
          default: 0
          description: 'Creativity intensity. Controls how much creative freedom is applied during upscaling.

            Valid values range from 0 (no creativity) to 100 (maximum creativity). Default is 0.

            '
          maximum: 100
          minimum: 0
          type: integer
        resolution:
          $ref: '#/components/schemas/resolution_1'
        fps_boost:
          default: false
          description: Enable FPS boost to increase the frame rate of the upscaled video.
          type: boolean
        sharpen:
          default: 0
          description: 'Video sharpness intensity control. Higher values increase edge definition and clarity.

            Valid values range from 0 (no sharpening) to 100 (maximum sharpness). Default is 0.

            '
          maximum: 100
          minimum: 0
          type: integer
        smart_grain:
          default: 0
          description: 'Applies a film grain effect to the output video. Helps preserve natural film grain and texture detail.

            Valid values range from 0 (no grain) to 100 (maximum grain). Default is 0.

            '
          maximum: 100
          minimum: 0
          type: integer
        flavor:
          $ref: '#/components/schemas/flavor_1'
        output_format:
          $ref: '#/components/schemas/output-format'
        webhook_url:
          description: 'Optional callback URL that will receive asynchronous notifications when the upscaling task completes.

            The webhook will be called with the task status and the upscaled video URL.

            '
          format: uri
          type: string
      required:
      - video
      type: object
    inline_object:
      example:
        message: message
      properties:
        message:
          type: string
      type: object
    inline_object_3:
      example:
        message: Service Unavailable. Please try again later.
      properties:
        message:
          example: Service Unavailable. Please try again later.
          type: string
      type: object
    get_all_style_transfer_tasks_200_response:
      example:
        data:
        - task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: CREATED
        - task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: CREATED
      properties:
        data:
          items:
            $ref: '#/components/schemas/task'
          type: array
      required:
      - data
      type: object
    output-format:
      default: h264
      description: 'Output video format. `h264` (default) returns an H.264 MP4. `prores_422_hq` returns an Apple ProRes 422 HQ master (.mov) alongside an H.264 preview.

        When `prores_422_hq` is selected the completed task''s `generated` array contains both files: the H.264 MP4 preview and the ProRes master, which can be identified by its `.mov` extension.

        '
      enum:
      - h264
      - prores_422_hq
      type: string
    task-detail_1:
      allOf:
      - $ref: '#/components/schemas/task'
      - properties:
          generated:
            items:
              description: URL of the generated image
              format: uri
              type: string
            type: array
        required:
        - generated
        type: object
      example:
        generated:
        - https://openapi-generator.tech
        - https://openapi-generator.tech
        task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        status: CREATED
  responses:
    401-unauthorized:
      content:
        application/json:
          examples:
            invalid_api_key:
              summary: API key is not valid
              value:
                message: Invalid API key
            missing_api_key:
              summary: API key is not provided
              value:
                message: Missing API key
          schema:
            $ref: '#/components/schemas/inline_object'
      description: Unauthorized - The client must authenticate itself to get the requested response.
    503-service-unavailable:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/inline_object_3'
      description: Service Unavailable
    task-detail-200-default-response:
      content:
        application/json:
          examples:
            success - created task:
              $ref: '#/components/examples/200-task-created'
            success - in progress task:
              $ref: '#/components/examples/200-task-in-progress'
            success - completed task:
              $ref: '#/components/examples/200-task-completed'
            success - failed task:
              $ref: '#/components/examples/200-task-failed'
          schema:
            $ref: '#/components/schemas/inline_object_4'
      description: OK - The task exists and the status is returned
    400-bad-request:
      content:
        application/json:
          examples:
            invalid_page:
              summary: Parameter 'page' is not valid
              value:
                message: Parameter 'page' must be greater than 0
            invalid_query:
              summary: Parameter 'query' is not valid
              value:
                message: Parameter 'query' must not be empty
            invalid_filter:
              summary: Parameter 'filter' is not valid
              value:
                message: Parameter 'filter' is not valid
            generic_bad_request:
              summary: Bad Request
              value:
                message: Parameter ':attribute' is not valid
          schema:
            $ref: '#/components/schemas/inline_object'
        application/problem+json:
          examples:
            invalid_page:
              summary: Parameter 'page' is not valid
              value:
                message: Validation error
                invalid_params:
                - field: page
                  reason: Parameter 'page' must be greater than 0
                - field: per_page
                  reason: Parameter 'per_page' must be greater than 0
          schema:
            $ref: '#/components/schemas/inline_object_1'
      description: Bad Request - The server could not understand the request due to invalid syntax.
    500-internal-server-error:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/inline_object_2'
      description: Internal Server Error - The server has encountered a situation it doesn't know how to handle.
    task-list-200-default-response:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/get_all_style_transfer_tasks_200_response'
      description: OK - Returns a list of tasks for the current type of Task
  examples:
    200-task-failed:
      summary: Success - Task failed
      value:
        data:
          generated: []
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: FAILED
    200-task-in-progress:
      summary: Success - Task in progress
      value:
        data:
          generated: []
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: IN_PROGRESS
    200-task-created:
      summary: Success - Task created
      value:
        data:
          generated: []
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: CREATED
    200-task-completed:
      summary: Success - Task completed
      value:
        data:
          generated:
          - https://ai-statics.freepik.com/completed_task_image.jpg
          task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: COMPLETED
  securitySchemes:
    magnificApiKey:
      description: 'Your Magnific API key. Required for authentication. [Learn how to obtain an API key](https://docs.magnific.com/quickstart)

        '
      in: header
      name: x-magnific-api-key
      type: apiKey
x-provenance:
  method: harvested
  publisher: Freepik
  source: https://storage.googleapis.com/fc-freepik-pro-rev1-eu-api-specs/magnific-api-v1-openapi.yaml?v=46\
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)