Freepik Upscaler Precision 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 Upscaler Precision API
  version: 1.0.0
servers:
- description: B2B API Production V1
  url: https://api.magnific.com
security:
- magnificApiKey: []
tags:
- name: upscaler-precision
paths:
  /v1/ai/image-upscaler-precision:
    get:
      description: Returns a list of all precision upscaler tasks. Each task includes its ID, current status, and output URL if completed.
      operationId: getAiImageUpscalerPrecisionTasks
      responses:
        '200':
          content:
            application/json:
              examples:
                success - return all tasks:
                  $ref: '#/components/examples/200-tasks-list'
              schema:
                $ref: '#/components/schemas/get_all_style_transfer_tasks_200_response'
          description: OK
        '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: Upscaler Precision - List tasks
      tags:
      - upscaler-precision
    post:
      description: 'Upscales an image while adding new visual elements or details.

        This endpoint may modify the original image content based on the prompt and inferred context.'
      operationId: postAiImageUpscalerPrecision
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request-content_2'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_style_transfer_task_status_200_response'
          description: OK
        '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: Upscaler Precision - Upscale image
      tags:
      - upscaler-precision
  /v1/ai/image-upscaler-precision/{task-id}:
    get:
      description: Returns the current status and output URL of a specific precision upscaler task. The output URL is included only if the task has completed successfully.
      operationId: getAiImageUpscalerPrecisionTask
      parameters:
      - description: ID of the task
        in: path
        name: task-id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success - completed task:
                  $ref: '#/components/examples/200-task-completed'
              schema:
                $ref: '#/components/schemas/get_style_transfer_task_status_200_response'
          description: OK - The task exists and the status is returned
        '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: Upscaler Precision - Get task status
      tags:
      - upscaler-precision
  /v1/ai/image-upscaler-precision-v2:
    get:
      description: Returns a list of all precision upscaler V2 tasks. Each task includes its ID, current status, and output URL if completed.
      operationId: getAiImageUpscalerPrecisionV2Tasks
      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: Upscaler Precision V2 - List tasks
      tags:
      - upscaler-precision
    post:
      description: 'Upscales an image while adding new visual elements or details (V2).

        This endpoint may modify the original image content based on the prompt and inferred context.'
      operationId: postAiImageUpscalerPrecisionV2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/request-content_3'
        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: Upscaler Precision V2 - Upscale image
      tags:
      - upscaler-precision
  /v1/ai/image-upscaler-precision-v2/{task-id}:
    get:
      description: Returns the current status and output URL of a specific precision upscaler V2 task. The output URL is included only if the task has completed successfully.
      operationId: getAiImageUpscalerPrecisionV2Task
      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: Upscaler Precision V2 - Get task status
      tags:
      - upscaler-precision
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
    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
    flavor:
      description: 'Image processing flavor that determines the upscaling style and optimization for different image types:

        - `sublime`: Optimized for artistic and illustrated images with smooth gradients and vibrant colors

        - `photo`: Optimized for photographic images, preserving natural colors and realistic details

        - `photo_denoiser`: Specialized for photos with noise reduction, ideal for low-light or grainy photographs

        '
      enum:
      - sublime
      - photo
      - photo_denoiser
      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
    inline_object:
      example:
        message: message
      properties:
        message:
          type: string
      type: object
    request_content_3_scale_factor:
      description: 'Image scaling factor for upscaling. Determines how much larger the output image will be compared to the input.

        For example, a scale ratio of 2 will double the dimensions (2x width and 2x height, resulting in 4x total pixels).

        Valid values range from 2 to 16. Can be provided as an integer or string.

        '
      oneOf:
      - maximum: 16
        minimum: 2
        type: integer
      - pattern: ^(2|3|4|5|6|7|8|9|1[0-6])$
        type: string
    get_style_transfer_task_status_200_response:
      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'
      required:
      - data
      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
    request-content_2:
      properties:
        image:
          description: Base64 image to upscale
          format: byte
          type: string
        webhook_url:
          description: Webhook URL
          format: uri
          type: string
        sharpen:
          default: 50
          description: Sharpen the image
          maximum: 100
          minimum: 0
          type: integer
        smart_grain:
          default: 7
          description: Smart grain
          maximum: 100
          minimum: 0
          type: integer
        ultra_detail:
          default: 30
          description: Ultra detail
          maximum: 100
          minimum: 0
          type: integer
        filter_nsfw:
          default: false
          description: Enable NSFW content filtering on the output image
          type: boolean
      required:
      - image
      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
    request-content_3:
      properties:
        image:
          description: 'Source image to upscale. Accepts either:

            - A publicly accessible HTTPS URL pointing to the image

            - A base64-encoded image string


            This image will be enhanced with AI-powered upscaling technology that intelligently adds details and improves image quality while increasing resolution.

            '
          type: string
        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 image URL.

            '
          format: uri
          type: string
        sharpen:
          default: 7
          description: 'Image sharpness intensity control. Higher values increase edge definition and clarity in the upscaled image.

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

            '
          maximum: 100
          minimum: 0
          type: integer
        smart_grain:
          default: 7
          description: 'Intelligent grain/texture enhancement for the upscaled image. Helps preserve natural film grain and texture detail.

            Higher values add more fine-grained texture to prevent the upscaled image from looking too smooth or artificial.

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

            '
          maximum: 100
          minimum: 0
          type: integer
        ultra_detail:
          default: 30
          description: 'Ultra detail enhancement level for the image upscaling process. This parameter controls how much fine detail

            the AI adds to the upscaled image, such as textures, patterns, and micro-details.

            Higher values create more intricate details. Valid values range from 0 to 100. Default is 30.

            '
          maximum: 100
          minimum: 0
          type: integer
        flavor:
          $ref: '#/components/schemas/flavor'
        scale_factor:
          $ref: '#/components/schemas/request_content_3_scale_factor'
        filter_nsfw:
          default: false
          description: Enable NSFW content filtering on the output image
          type: boolean
      required:
      - image
      type: object
    task-detail:
      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
    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-tasks-list:
      summary: Success - Return all tasks
      value:
        data:
        - task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          status: IN_PROGRESS
        - task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee92
          status: COMPLETED
        - task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee93
          status: COMPLETED
        - task_id: 046b6c7f-0b8a-43b9-b35d-6489e6daee93
          status: CREATED
    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)